Skip to content

Commit

Permalink
Doc fix
Browse files Browse the repository at this point in the history 
Signed-off-by: Alina Buzachis <[email protected]>
  • Loading branch information
@alinabuzachis
alinabuzachis committed Jun 3, 2021
1 parent 987a9c7 commit 7890fc2
Show file tree
Hide file tree
Showing 2 changed files with 63 additions and 63 deletions.
62 changes: 31 additions & 31 deletions plugins/modules/rds_option_group.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
- Options in this list are added to the option group.
- If already present, the specified configuration is used to update the existing configuration.
- If none are supplied, any existing options are removed.
type: complex
type: dict
suboptions:
option_name:
description: The configuration of options to include in a group.
Expand Down Expand Up @@ -195,7 +195,7 @@
RETURN = r'''
allows_vpc_and_non_vpc_instance_memberships:
description: Indicates whether this option group can be applied to both VPC and non-VPC instances.
returned: I(state=present)
returned: always
type: bool
sample: false
changed:
Expand All @@ -205,151 +205,151 @@
sample: true
engine_name:
description: Indicates the name of the engine that this option group can be applied to.
returned: I(state=present)
returned: always
type: str
sample: "mysql"
major_engine_version:
description: Indicates the major engine version associated with this option group.
returned: I(state=present)
returned: always
type: str
sample: "5.6"
option_group_arn:
description: The Amazon Resource Name (ARN) for the option group.
returned: I(state=present)
returned: always
type: str
sample: "arn:aws:rds:ap-southeast-2:721066863947:og:ansible-test-option-group"
option_group_description:
description: Provides a description of the option group.
returned: I(state=present)
returned: always
type: str
sample: "test mysql option group"
option_group_name:
description: Specifies the name of the option group.
returned: I(state=present)
returned: always
type: str
sample: "test-mysql-option-group"
options:
description: Indicates what options are available in the option group.
returned: I(state=present)
returned: always
type: list
elements: dict
contains:
db_security_group_memberships:
description: If the option requires access to a port, then this DB security group allows access to the port.
returned: I(state=present)
returned: always
type: list
elements: dict
contains:
status:
description: The status of the DB security group.
returned: I(state=present)
returned: always
type: str
sample: "available"
db_security_group_name:
description: The name of the DB security group.
returned: I(state=present)
returned: always
type: str
sample: "mydbsecuritygroup"
option_description:
description: The description of the option.
returned: I(state=present)
returned: always
type: str
sample: "Innodb Memcached for MySQL"
option_name:
description: The name of the option.
returned: I(state=present)
returned: always
type: str
sample: "MEMCACHED"
option_settings:
description: The name of the option.
returned: I(state=present)
returned: always
type: list
contains:
allowed_values:
description: The allowed values of the option setting.
returned: I(state=present)
returned: always
type: str
sample: "1-2048"
apply_type:
description: The DB engine specific parameter type.
returned: I(state=present)
returned: always
type: str
sample: "STATIC"
data_type:
description: The data type of the option setting.
returned: I(state=present)
returned: always
type: str
sample: "INTEGER"
default_value:
description: The default value of the option setting.
returned: I(state=present)
returned: always
type: str
sample: "1024"
description:
description: The description of the option setting.
returned: I(state=present)
returned: always
type: str
sample: "Verbose level for memcached."
is_collection:
description: Indicates if the option setting is part of a collection.
returned: I(state=present)
returned: always
type: bool
sample: true
is_modifiable:
description: A Boolean value that, when true, indicates the option setting can be modified from the default.
returned: I(state=present)
returned: always
type: bool
sample: true
name:
description: The name of the option that has settings that you can set.
returned: I(state=present)
returned: always
type: str
sample: "INNODB_API_ENABLE_MDL"
value:
description: The current value of the option setting.
returned: I(state=present)
returned: always
type: str
sample: "0"
permanent:
description: Indicate if this option is permanent.
returned: I(state=present)
returned: always
type: bool
sample: true
persistent:
description: Indicate if this option is persistent.
returned: I(state=present)
returned: always
type: bool
sample: true
port:
description: If required, the port configured for this option to use.
returned: I(state=present)
returned: always
type: int
sample: 11211
vpc_security_group_memberships:
description: If the option requires access to a port, then this VPC security group allows access to the port.
returned: I(state=present)
returned: always
type: list
elements: dict
contains:
status:
description: The status of the VPC security group.
returned: I(state=present)
returned: always
type: str
sample: "available"
vpc_security_group_id:
description: The name of the VPC security group.
returned: I(state=present)
returned: always
type: str
sample: "sg-0cd636a23ae76e9a4"
vpc_id:
description: If present, this option group can only be applied to instances that are in the VPC indicated by this field.
returned: I(state=present)
returned: always
type: str
sample: "vpc-bf07e9d6"
tags:
description: The tags associated the Internet Gateway.
type: dict
returned: I(state=present)
returned: always
sample: {
"Ansible": "Test"
}
Expand Down
64 changes: 32 additions & 32 deletions plugins/modules/rds_option_group_info.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,159 +77,159 @@
contains:
allows_vpc_and_non_vpc_instance_memberships:
description: Indicates whether this option group can be applied to both VPC and non-VPC instances.
returned: I(state=present)
returned: always
type: bool
sample: false
engine_name:
description: Indicates the name of the engine that this option group can be applied to.
returned: I(state=present)
returned: always
type: str
sample: "mysql"
major_engine_version:
description: Indicates the major engine version associated with this option group.
returned: I(state=present)
returned: always
type: str
sample: "5.6"
option_group_arn:
description: The Amazon Resource Name (ARN) for the option group.
returned: I(state=present)
returned: always
type: str
sample: "arn:aws:rds:ap-southeast-2:721066863947:og:ansible-test-option-group"
option_group_description:
description: Provides a description of the option group.
returned: I(state=present)
returned: always
type: str
sample: "test mysql option group"
option_group_name:
description: Specifies the name of the option group.
returned: I(state=present)
returned: always
type: str
sample: "test-mysql-option-group"
options:
description: Indicates what options are available in the option group.
returned: I(state=present)
returned: always
type: complex
contains:
db_security_group_memberships:
description: If the option requires access to a port, then this DB security group allows access to the port.
returned: I(state=present)
returned: always
type: complex
sample: list
elements: dict
contains:
status:
description: The status of the DB security group.
returned: I(state=present)
returned: always
type: str
sample: "available"
db_security_group_name:
description: The name of the DB security group.
returned: I(state=present)
returned: always
type: str
sample: "mydbsecuritygroup"
option_description:
description: The description of the option.
returned: I(state=present)
returned: always
type: str
sample: "Innodb Memcached for MySQL"
option_name:
description: The name of the option.
returned: I(state=present)
returned: always
type: str
sample: "MEMCACHED"
option_settings:
description: The name of the option.
returned: I(state=present)
returned: always
type: complex
contains:
allowed_values:
description: The allowed values of the option setting.
returned: I(state=present)
returned: always
type: str
sample: "1-2048"
apply_type:
description: The DB engine specific parameter type.
returned: I(state=present)
returned: always
type: str
sample: "STATIC"
data_type:
description: The data type of the option setting.
returned: I(state=present)
returned: always
type: str
sample: "INTEGER"
default_value:
description: The default value of the option setting.
returned: I(state=present)
returned: always
type: str
sample: "1024"
description:
description: The description of the option setting.
returned: I(state=present)
returned: always
type: str
sample: "Verbose level for memcached."
is_collection:
description: Indicates if the option setting is part of a collection.
returned: I(state=present)
returned: always
type: bool
sample: true
is_modifiable:
description: A Boolean value that, when true, indicates the option setting can be modified from the default.
returned: I(state=present)
returned: always
type: bool
sample: true
name:
description: The name of the option that has settings that you can set.
returned: I(state=present)
returned: always
type: str
sample: "INNODB_API_ENABLE_MDL"
value:
description: The current value of the option setting.
returned: I(state=present)
returned: always
type: str
sample: "0"
permanent:
description: Indicate if this option is permanent.
returned: I(state=present)
returned: always
type: bool
sample: true
persistent:
description: Indicate if this option is persistent.
returned: I(state=present)
returned: always
type: bool
sample: true
port:
description: If required, the port configured for this option to use.
returned: I(state=present)
returned: always
type: int
sample: 11211
vpc_security_group_memberships:
description: If the option requires access to a port, then this VPC security group allows access to the port.
returned: I(state=present)
returned: always
type: list
elements: dict
contains:
status:
description: The status of the VPC security group.
returned: I(state=present)
returned: always
type: str
sample: "available"
vpc_security_group_id:
description: The name of the VPC security group.
returned: I(state=present)
returned: always
type: str
sample: "sg-0cd636a23ae76e9a4"
vpc_id:
description: If present, this option group can only be applied to instances that are in the VPC indicated by this field.
returned: I(state=present)
returned: always
type: str
sample: "vpc-bf07e9d6"
tags:
description: The tags associated the Internet Gateway.
type: dict
returned: I(state=present)
sample:
tags:
returned: always
sample: {
"Ansible": "Test"
}
'''

Expand Down

0 comments on commit 7890fc2

Please sign in to comment.