ansible-collections / amazon.cloud

Ansible Collection for Amazon AWS' Cloud Control API
GNU General Public License v3.0
12 stars 12 forks source link

Fix option names #110

Open alinabuzachis opened 1 year ago

alinabuzachis commented 1 year ago
SUMMARY

Add the original option name as an alias to avoid issues when snake cased option names are not correctly reversed to the original CamelCase. Use the alias via the CloudControl API rather than performinng that CamelCase transformations.

Collection re-generated using https://github.com/ansible-community/ansible.content_builder/pull/62

ISSUE TYPE
COMPONENT NAME
ADDITIONAL INFORMATION
github-actions[bot] commented 1 year ago

Docs Build 📝

Thank you for contribution!✨

The docsite for this PR is available for download as an artifact from this run: https://github.com/ansible-collections/amazon.cloud/actions/runs/6029496303

You can compare to the docs for the main branch here: https://ansible-collections.github.io/amazon.cloud/branch/main

File changes:

  • D collections/amazon/cloud/backup_framework_module.html
  • D collections/amazon/cloud/backup_report_plan_module.html
  • D collections/amazon/cloud/cloudtrail_event_data_store_module.html
  • D collections/amazon/cloud/ec2_placement_group_module.html
  • D collections/amazon/cloud/kms_replica_key_module.html
  • D collections/amazon/cloud/lambda_code_signing_config_module.html
  • D collections/amazon/cloud/lambda_event_source_mapping_module.html
  • D collections/amazon/cloud/logs_query_definition_module.html
  • D collections/amazon/cloud/ssm_resource_data_sync_module.html
  • D collections/amazon/cloud/wafv2_ip_set_module.html
  • D collections/amazon/cloud/wafv2_regex_pattern_set_module.html
  • M collections/amazon/cloud/autoscaling_launch_configuration_module.html
  • M collections/amazon/cloud/autoscaling_lifecycle_hook_module.html
  • M collections/amazon/cloud/autoscaling_warm_pool_module.html
  • M collections/amazon/cloud/backup_backup_vault_module.html
  • M collections/amazon/cloud/cloudtrail_trail_module.html
  • M collections/amazon/cloud/cloudwatch_composite_alarm_module.html
  • M collections/amazon/cloud/cloudwatch_metric_stream_module.html
  • M collections/amazon/cloud/dynamodb_global_table_module.html
  • M collections/amazon/cloud/ecr_repository_module.html
  • M collections/amazon/cloud/ecs_capacity_provider_module.html
  • M collections/amazon/cloud/ecs_cluster_capacity_provider_associations_module.html
  • M collections/amazon/cloud/ecs_cluster_module.html
  • M collections/amazon/cloud/ecs_primary_task_set_module.html
  • M collections/amazon/cloud/eks_addon_module.html
  • M collections/amazon/cloud/eks_cluster_module.html
  • M collections/amazon/cloud/eks_fargate_profile_module.html
  • M collections/amazon/cloud/iam_instance_profile_module.html
  • M collections/amazon/cloud/iam_role_module.html
  • M collections/amazon/cloud/iam_server_certificate_module.html
  • M collections/amazon/cloud/index.html
  • M collections/amazon/cloud/kms_alias_module.html
  • M collections/amazon/cloud/lambda_function_module.html
  • M collections/amazon/cloud/logs_log_group_module.html
  • M collections/amazon/cloud/logs_metric_filter_module.html
  • M collections/amazon/cloud/logs_resource_policy_module.html
  • M collections/amazon/cloud/memorydb_acl_module.html
  • M collections/amazon/cloud/memorydb_cluster_module.html
  • M collections/amazon/cloud/memorydb_parameter_group_module.html
  • M collections/amazon/cloud/memorydb_subnet_group_module.html
  • M collections/amazon/cloud/memorydb_user_module.html
  • M collections/amazon/cloud/rds_db_cluster_parameter_group_module.html
  • M collections/amazon/cloud/rds_db_instance_module.html
  • M collections/amazon/cloud/rds_db_proxy_endpoint_module.html
  • M collections/amazon/cloud/rds_db_proxy_module.html
  • M collections/amazon/cloud/rds_db_subnet_group_module.html
  • M collections/amazon/cloud/rds_global_cluster_module.html
  • M collections/amazon/cloud/rds_option_group_module.html
  • M collections/amazon/cloud/redshift_cluster_module.html
  • M collections/amazon/cloud/redshift_endpoint_access_module.html
  • M collections/amazon/cloud/redshift_endpoint_authorization_module.html
  • M collections/amazon/cloud/redshift_event_subscription_module.html
  • M collections/amazon/cloud/redshift_scheduled_action_module.html
  • M collections/amazon/cloud/route53_dnssec_module.html
  • M collections/amazon/cloud/route53_key_signing_key_module.html
  • M collections/amazon/cloud/s3_access_point_module.html
  • M collections/amazon/cloud/s3_bucket_module.html
  • M collections/amazon/cloud/s3_multi_region_access_point_module.html
  • M collections/amazon/cloud/s3_multi_region_access_point_policy_module.html
  • M collections/amazon/cloud/s3objectlambda_access_point_module.html
  • M collections/amazon/cloud/s3objectlambda_access_point_policy_module.html
  • M collections/amazon/cloud/ssm_document_module.html
  • M collections/amazon/cloud/wafv2_logging_configuration_module.html
  • M collections/amazon/cloud/wafv2_web_acl_association_module.html
  • M collections/index_module.html
Click to see the diff comparison. **NOTE:** only file modifications are shown here. New and deleted files are excluded. See the file list and check the published docs to see those files. **The diff output was truncated because it exceeded the maximum size.** ```diff diff --git a/home/runner/work/amazon.cloud/amazon.cloud/docsbuild/base/collections/amazon/cloud/autoscaling_launch_configuration_module.html b/home/runner/work/amazon.cloud/amazon.cloud/docsbuild/head/collections/amazon/cloud/autoscaling_launch_configuration_module.html index f05c59f..81a527a 100644 --- a/home/runner/work/amazon.cloud/amazon.cloud/docsbuild/base/collections/amazon/cloud/autoscaling_launch_configuration_module.html +++ b/home/runner/work/amazon.cloud/amazon.cloud/docsbuild/head/collections/amazon/cloud/autoscaling_launch_configuration_module.html @@ -196,8 +196,10 @@ see
-

associate_public_ip_address

-

boolean

+
+

associate_public_ip_address

+

aliases: AssociatePublicIpAddress

+

boolean

For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the groups instances.

Choices:

@@ -224,29 +226,47 @@ see
-

block_device_mappings

-

list / elements=dictionary

+
+

block_device_mappings

+

aliases: BlockDeviceMappings

+

list / elements=dictionary

block_device_mapping is a property of AWS::AutoScaling::LaunchConfiguration that describes a block device mapping for an Auto Scaling group.

-

device_name

-

string

+
+
+
+

device_name

+

aliases: DeviceName

+

string

The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh).

-

ebs

-

dictionary

+
+
+
+

ebs

+

aliases: Ebs

+

dictionary

Parameters used to automatically set up EBS volumes when an instance is launched.block_device is a subproperty of block_device_mapping that describes an Amazon EBS volume.

-

delete_on_termination

-

boolean

+
+
+
+
+
+
+
+

delete_on_termination

+

aliases: DeleteOnTermination

+

boolean

Indicates whether the volume is deleted on instance termination.

Choices:

@@ -257,8 +277,16 @@ see
-

encrypted

-

boolean

+
+
+
+
+
+
+
+

encrypted

+

aliases: Encrypted

+

boolean

Specifies whether the volume should be encrypted.

Choices:

@@ -269,43 +297,87 @@ see
-

iops

-

integer

+
+
+
+
+
+
+
+

iops

+

aliases: Iops

+

integer

The number of input/output (I/O) operations per second (IOPS) to provision for the volume.

-

snapshot_id

-

string

+
+
+
+
+
+
+
+

snapshot_id

+

aliases: SnapshotId

+

string

The snapshot ID of the volume to use.

-

throughput

-

integer

+
+
+
+
+
+
+
+

throughput

+

aliases: Throughput

+

integer

The throughput (MiBps) to provision for a gp3 volume.

-

volume_size

-

integer

+
+
+
+
+
+
+
+

volume_size

+

aliases: VolumeSize

+

integer

The volume size, in GiBs.

-

volume_type

-

string

+
+
+
+
+
+
+
+

volume_type

+

aliases: VolumeType

+

string

The volume type.

-

no_device

-

boolean

+
+
+
+

no_device

+

aliases: NoDevice

+

boolean

Setting this value to true suppresses the specified device included in the block device mapping of the AMI.

Choices:

@@ -316,22 +388,30 @@ see
-

virtual_name

-

string

+
+
+
+

virtual_name

+

aliases: VirtualName

+

string

The name of the virtual device.

- -

string

+ +

classic_link_vpc_id

+

aliases: ClassicLinkVPCId

+

string

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.

- -

list / elements=string

+ +

classic_link_vpc_security_groups

+

aliases: ClassicLinkVPCSecurityGroups

+

list / elements=string

The IDs of one or more security groups for the VPC that you specified in the ClassicLinkVPCId property.

@@ -350,8 +430,10 @@ see
-

ebs_optimized

-

boolean

+
+

ebs_optimized

+

aliases: EbsOptimized

+

boolean

Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false).

Choices:

@@ -389,30 +471,38 @@ see
-

iam_instance_profile

-

string

+
+

iam_instance_profile

+

aliases: IamInstanceProfile

+

string

Provides the name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.

The instance profile contains the IAM role.

-

image_id

-

string

+
+

image_id

+

aliases: ImageId

+

string

Provides the unique ID of the Amazon Machine Image (AMI) that was assigned during registration.

-

instance_id

-

string

+
+

instance_id

+

aliases: InstanceId

+

string

The ID of the Amazon EC2 instance you want to use to create the launch configuration.

-

instance_monitoring

-

boolean

+
+

instance_monitoring

+

aliases: InstanceMonitoring

+

boolean

Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.

Choices:

@@ -423,65 +513,89 @@ see
-

instance_type

-

string

+
+

instance_type

+

aliases: InstanceType

+

string

Specifies the instance type of the EC2 instance.

-

kernel_id

-

string

+
+

kernel_id

+

aliases: KernelId

+

string

Provides the ID of the kernel associated with the EC2 AMI.

-

key_name

-

string

+
+

key_name

+

aliases: KeyName

+

string

Provides the name of the EC2 key pair.

-

launch_configuration_name

-

string

+
+

launch_configuration_name

+

aliases: LaunchConfigurationName

+

string

The name of the launch configuration.

This name must be unique per Region per account.

-

metadata_options

-

dictionary

+
+

metadata_options

+

aliases: MetadataOptions

+

dictionary

The metadata options for the instances.metadata_options is a property of AWS::AutoScaling::LaunchConfiguration that describes metadata options for the instances.

-

http_endpoint

-

string

+
+
+
+

http_endpoint

+

aliases: HttpEndpoint

+

string

This parameter enables or disables the HTTP metadata endpoint on your instances.

-

http_put_response_hop_limit

-

integer

+
+
+
+

http_put_response_hop_limit

+

aliases: HttpPutResponseHopLimit

+

integer

The desired HTTP PUT response hop limit for instance metadata requests.

-

http_tokens

-

string

+
+
+
+

http_tokens

+

aliases: HttpTokens

+

string

The state of token usage for your instance metadata requests.

-

placement_tenancy

-

string

+
+

placement_tenancy

+

aliases: PlacementTenancy

+

string

The tenancy of the instance, either default or dedicated.

@@ -499,8 +613,10 @@ see
-

ram_disk_id

-

string

+
+

ram_disk_id

+

aliases: RamDiskId

+

string

The ID of the RAM disk to select.

@@ -538,8 +654,10 @@ see
-

security_groups

-

list / elements=string

+
+

security_groups

+

aliases: SecurityGroups

+

list / elements=string

A list that contains the security groups to assign to the instances in the Auto Scaling group.

@@ -563,8 +681,10 @@ see
-

spot_price

-

string

+
+

spot_price

+

aliases: SpotPrice

+

string

The maximum hourly price you are willing to pay for any Spot Instances launched to fulfill the request.

@@ -589,8 +709,10 @@ see
-

user_data

-

string

+
+

user_data

+

alinabuzachis commented 10 months ago

The same issue, the CI does not use the fork's branch, but the main repo's branch, that's why the eke tests are still failing.