Skip to content

job.md

Latest commit

 

History

History
1255 lines (845 loc) · 55.2 KB

job.md

File metadata and controls

1255 lines (845 loc) · 55.2 KB
page_title subcategory description
cloudautomator_job Data Source - terraform-provider-cloudautomator

cloudautomator_job (Data Source)

Example Usage

data "cloudautomator_job" "example-job" {
  id = 123
}

Schema

Required

  • id (String) Job ID

Optional

  • attach_user_policy_action_value (Block List, Max: 1) "IAM: Attach Policy to IAM User" action value (see below for nested schema)
  • authorize_security_group_ingress_action_value (Block List, Max: 1) "EC2: Authorize security group ingress" action value (see below for nested schema)
  • bulk_delete_ebs_snapshots_action_value (Block List, Max: 1) "EC2: Delete old EBS Snapshots" action value (see below for nested schema)
  • bulk_delete_images_action_value (Block List, Max: 1) "EC2: Delete old AMIs and Snapshots" action value (see below for nested schema)
  • bulk_delete_rds_cluster_snapshots_action_value (Block List, Max: 1) "RDS(Aurora): Delete old DB cluster snapshots" action value (see below for nested schema)
  • bulk_delete_rds_snapshots_action_value (Block List, Max: 1) "RDS: Delete old DB snapshots" action value (see below for nested schema)
  • bulk_stop_instances_action_value (Block List, Max: 1) "EC2: Stop ALL instances" action value (see below for nested schema)
  • change_elasticache_node_type_action_value (Block List, Max: 1) "ElastiCache: Change node type" action value (see below for nested schema)
  • change_instance_type_action_value (Block List, Max: 1) "EC2: Change instance type" action value (see below for nested schema)
  • change_rds_cluster_instance_class_action_value (Block List, Max: 1) "RDS(Aurora): Change DB instance class" action value (see below for nested schema)
  • change_rds_instance_class_action_value (Block List, Max: 1) "RDS: Change DB instance class" action value (see below for nested schema)
  • copy_ebs_snapshot_action_value (Block List, Max: 1) "EC2: Copy EBS snapshot" action value (see below for nested schema)
  • copy_image_action_value (Block List, Max: 1) "EC2: Copy AMI" action value (see below for nested schema)
  • copy_rds_cluster_snapshot_action_value (Block List, Max: 1) "RDS(Aurora): Copy DB cluster snapshot" action value (see below for nested schema)
  • copy_rds_snapshot_action_value (Block List, Max: 1) "RDS: Copy DB snapshot" action value (see below for nested schema)
  • create_ebs_snapshot_action_value (Block List, Max: 1) "EC2: Create EBS snapshot" action value (see below for nested schema)
  • create_fsx_backup_action_value (Block List, Max: 1) "FSx: Create a backup" action value (see below for nested schema)
  • create_image_action_value (Block List, Max: 1) "EC2: Create AMI" action value (see below for nested schema)
  • create_nat_gateway_action_value (Block List, Max: 1) "VPC: Create NAT Gateway" action value (see below for nested schema)
  • create_rds_cluster_snapshot_action_value (Block List, Max: 1) "RDS(Aurora): Create DB cluster snapshot" action value (see below for nested schema)
  • create_rds_snapshot_action_value (Block List, Max: 1) "RDS: Create DB snapshot" action value (see below for nested schema)
  • create_redshift_snapshot_action_value (Block List, Max: 1) "Redshift: Create cluster snapshot" action value (see below for nested schema)
  • delay_action_value (Block List, Max: 1) "Other: Delay" action value (see below for nested schema)
  • delete_cluster_action_value (Block List, Max: 1) "Redshift: Delete cluster" action value (see below for nested schema)
  • delete_nat_gateway_action_value (Block List, Max: 1) "VPC: Delete NAT Gateway" action value (see below for nested schema)
  • delete_rds_cluster_action_value (Block List, Max: 1) "RDS(Aurora): Delete DB cluster" action value (see below for nested schema)
  • delete_rds_instance_action_value (Block List, Max: 1) "RDS: Delete DB instance" action value (see below for nested schema)
  • deregister_instances_action_value (Block List, Max: 1) "ELB(CLB): De-register EC2 instance" action value (see below for nested schema)
  • deregister_target_instances_action_value (Block List, Max: 1) "ELB(ALB/NLB): Deregister EC2 instances from target group" action value (see below for nested schema)
  • describe_metadata_action_value (Block List, Max: 1) "DR: Update EC2 instance metadata" action value (see below for nested schema)
  • detach_user_policy_action_value (Block List, Max: 1) "IAM: Detach Policy to IAM User" action value (see below for nested schema)
  • disaster_recovery_action_value (Block List, Max: 1) "DR: Launch EC2 instance" action value (see below for nested schema)
  • dynamodb_start_backup_job_action_value (Block List, Max: 1) "DynamoDB: Backup table" action value (see below for nested schema)
  • ec2_start_backup_job_action_value (Block List, Max: 1) "EC2: Backup instance" action value (see below for nested schema)
  • ecs_change_service_task_count_action_value (Block List, Max: 1) "ECS: Change service task count" action value (see below for nested schema)
  • efs_start_backup_job_action_value (Block List, Max: 1) "EFS: Backup file system" action value (see below for nested schema)
  • google_compute_insert_machine_image_action_value (Block List, Max: 1) "Compute Engine: create machine image" action value (see below for nested schema)
  • no_action_action_value (Block List, Max: 1) "Other: No Action" action value (see below for nested schema)
  • rds_cluster_change_capacity_action_value (Block List, Max: 1) "RDS(Aurora): Change DB cluster ACU" action value (see below for nested schema)
  • reboot_rds_instances_action_value (Block List, Max: 1) "RDS: Reboot DB instance" action value (see below for nested schema)
  • reboot_workspaces_action_value (Block List, Max: 1) "WorkSpaces: Reboot WorkSpace" action value (see below for nested schema)
  • rebuild_workspaces_action_value (Block List, Max: 1) "WorkSpaces: Rebuild WorkSpace" action value (see below for nested schema)
  • register_instances_action_value (Block List, Max: 1) "ELB(CLB): Register EC2 instance" action value (see below for nested schema)
  • register_target_instances_action_value (Block List, Max: 1) "ELB(ALB/NLB): Register EC2 instances to target group" action value (see below for nested schema)
  • restore_from_cluster_snapshot_action_value (Block List, Max: 1) "Redshift: Restore from snapshot" action value (see below for nested schema)
  • restore_rds_cluster_action_value (Block List, Max: 1) "RDS(Aurora): Restore DB cluster from DB cluster snapshot" action value (see below for nested schema)
  • restore_rds_instance_action_value (Block List, Max: 1) "RDS: Restore from DB snapshot" action value (see below for nested schema)
  • revoke_security_group_ingress_action_value (Block List, Max: 1) "EC2: Revoke security group ingress" action value (see below for nested schema)
  • run_ecs_tasks_fargate_action_value (Block List, Max: 1) "ECS: Run task (Fargate)" action value (see below for nested schema)
  • s3_start_backup_job_action_value (Block List, Max: 1) "S3: Backup" action value (see below for nested schema)
  • send_command_action_value (Block List, Max: 1) "EC2: Send command on instance" action value (see below for nested schema)
  • start_instances_action_value (Block List, Max: 1) "EC2: Start instance" action value (see below for nested schema)
  • start_rds_clusters_action_value (Block List, Max: 1) "RDS(Aurora): Start DB cluster" action value (see below for nested schema)
  • start_rds_instances_action_value (Block List, Max: 1) "RDS: Start DB instance" action value (see below for nested schema)
  • start_workspaces_action_value (Block List, Max: 1) "WorkSpaces: Start WorkSpace" action value (see below for nested schema)
  • stop_ecs_tasks_action_value (Block List, Max: 1) "ECS: Stop task" action value (see below for nested schema)
  • stop_instances_action_value (Block List, Max: 1) "EC2: Stop instance" action value (see below for nested schema)
  • stop_rds_clusters_action_value (Block List, Max: 1) "RDS(Aurora): Stop DB cluster" action value (see below for nested schema)
  • stop_rds_instances_action_value (Block List, Max: 1) "RDS: Stop DB instance" action value (see below for nested schema)
  • terminate_workspaces_action_value (Block List, Max: 1) "WorkSpaces: Remove WorkSpace" action value (see below for nested schema)
  • update_record_set_action_value (Block List, Max: 1) "Route 53: Update Resource Record Set" action value (see below for nested schema)
  • vault_recovery_point_start_copy_job_action_value (Block List, Max: 1) "Backup: Copy vault recovery point" action value (see below for nested schema)
  • windows_update_action_value (Block List, Max: 1) "EC2: Windows Update to instance (Old version)" action value (see below for nested schema)
  • windows_update_v2_action_value (Block List, Max: 1) "EC2: Windows Update to instance (New version)" action value (see below for nested schema)

Read-Only

  • action_type (String) Action type
  • allow_runtime_action_values (Boolean) Whether the value of the action setting is specified at runtime or not
  • aws_account_id (Number) AWS account ID
  • aws_account_ids (List of Number) AWS account IDs
  • completed_post_process_id (List of Number) Array containing post-process IDs to be executed if the job is successful
  • cron_rule_value (List of Object) Timer trigger value (see below for nested schema)
  • effective_date (String) Effective date
  • expiration_date (String) Expiration date
  • failed_post_process_id (List of Number) Array containing post-process IDs to be executed if the job fails
  • group_id (Number) Group ID
  • name (String) Job Name
  • rule_type (String) Trigger type
  • schedule_rule_value (List of Object) Schedule trigger value (see below for nested schema)
  • sqs_v2_rule_value (List of Object) SQS trigger value (see below for nested schema)

Nested Schema for attach_user_policy_action_value

Required:

  • policy_arn (String) ARN of the policy to attach
  • user_name (String) Name of the user to attach the policy to

Nested Schema for authorize_security_group_ingress_action_value

Required:

  • cidr_ip (String) CIDR IP
  • ip_protocol (String) IP protocol
  • region (String) AWS Region in which the target resource resides
  • specify_security_group (String) How to identify target resources
  • to_port (String) port

Optional:

  • security_group_id (String) Target security group ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource

Nested Schema for bulk_delete_ebs_snapshots_action_value

Required:

  • exclude_by_tag_bulk_delete_ebs_snapshots (Boolean) Specifies whether to exclude EBS Snapshots with certain tags from deletion
  • specify_base_date (String) Specifies the method for determining which EBS Snapshots to delete

Optional:

  • before_date (String) The date used to identify EBS Snapshots for deletion
  • before_days (Number) The number of days used to identify EBS Snapshots to be deleted
  • exclude_by_tag_key_bulk_delete_ebs_snapshots (String) The tag key used to identify EBS Snapshots to exclude from deletion
  • exclude_by_tag_value_bulk_delete_ebs_snapshots (String) The tag value used to identify EBS Snapshots to exclude from deletion

Nested Schema for bulk_delete_images_action_value

Required:

  • exclude_by_tag_bulk_delete_images (Boolean) Specifies whether to exclude AMIs with certain tags from deletion
  • specify_base_date (String) Specifies the method for determining which AMIs to delete

Optional:

  • before_date (String) The date used to identify AMIs for deletion
  • before_days (Number) The number of days used to identify AMIs to be deleted
  • exclude_by_tag_key_bulk_delete_images (String) The tag key used to identify AMIs to exclude from deletion
  • exclude_by_tag_value_bulk_delete_images (String) The tag value used to identify AMIs to exclude from deletion

Nested Schema for bulk_delete_rds_cluster_snapshots_action_value

Required:

  • exclude_by_tag_bulk_delete_rds_cluster_snapshots (Boolean) Specifies whether to exclude DB cluster snapshots with certain tags from deletion
  • specify_base_date (String) Specifies the method for determining which DB cluster snapshots to delete

Optional:

  • before_date (String) The date used to identify DB cluster snapshots for deletion
  • before_days (Number) The number of days used to identify DB cluster snapshots to be deleted
  • exclude_by_tag_key_bulk_delete_rds_cluster_snapshots (String) The tag key used to identify DB cluster snapshots to exclude from deletion
  • exclude_by_tag_value_bulk_delete_rds_cluster_snapshots (String) The tag value used to identify DB cluster snapshots to exclude from deletion

Nested Schema for bulk_delete_rds_snapshots_action_value

Required:

  • exclude_by_tag_bulk_delete_rds_snapshots (Boolean) Specifies whether to exclude DB snapshots with certain tags from deletion
  • specify_base_date (String) Specifies the method for determining which DB snapshots to delete

Optional:

  • before_date (String) The date used to identify DB snapshots for deletion
  • before_days (Number) The number of days used to identify DB snapshots to be deleted
  • exclude_by_tag_key_bulk_delete_rds_snapshots (String) The tag key used to identify DB snapshots to exclude from deletion
  • exclude_by_tag_value_bulk_delete_rds_snapshots (String) The tag value used to identify DB snapshots to exclude from deletion

Nested Schema for bulk_stop_instances_action_value

Required:

  • exclude_by_tag (Boolean) Whether to exclude instances with the specified tag from the target

Optional:

  • exclude_by_tag_key (String) Tag key used to exclude instances from the target
  • exclude_by_tag_value (String) Tag value used to exclude instances from the target

Nested Schema for change_elasticache_node_type_action_value

Required:

  • node_type (String) Node type after modification
  • region (String) AWS Region in which the target ElastiCache cluster resides
  • tag_key (String) Tag key used to identify the ElastiCache cluster
  • tag_value (String) Tag value used to identify the ElastiCache cluster

Nested Schema for change_instance_type_action_value

Required:

  • instance_type (String) Changed instance type
  • region (String) AWS Region in which the target resource resides
  • specify_instance (String) How to identify target resources

Optional:

  • instance_id (String) Target EC2 instance ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource

Nested Schema for change_rds_cluster_instance_class_action_value

Required:

  • db_instance_class (String) DB instance class after modification
  • region (String) AWS Region in which the target resource resides
  • specify_rds_instance (String) How to identify target resources

Optional:

  • rds_instance_id (String) Target DB instance ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource

Nested Schema for change_rds_instance_class_action_value

Required:

  • db_instance_class (String) DB instance class after modification
  • region (String) AWS Region in which the target resource resides
  • specify_rds_instance (String) How to identify target resources

Optional:

  • rds_instance_id (String) Target DB instance ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource

Nested Schema for copy_ebs_snapshot_action_value

Required:

  • destination_region (String) AWS Region to copy to
  • source_region (String) AWS Region from which the copy was made
  • specify_ebs_snapshot (String) How to identify target resources
  • trace_status (String) Whether to Verify completion status of the resource

Optional:

  • snapshot_id (String) Target EBS snapshot ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource

Nested Schema for copy_image_action_value

Required:

  • destination_region (String) AWS Region to copy to
  • source_region (String) AWS Region from which the copy was made
  • specify_image (String) How to identify target resources

Optional:

  • generation (Number) Number of AMI generations to be managed (0-10). Required when specify_image is 'tag'
  • source_image_id (String) 対象のAMIのID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • trace_status (String) Whether to Verify completion status of the resource

Nested Schema for copy_rds_cluster_snapshot_action_value

Required:

  • destination_region (String) AWS Region to copy to
  • source_region (String) AWS Region from which the copy was made
  • specify_rds_cluster_snapshot (String) How to identify target resources

Optional:

  • kms_key_id (String) KMS key ID
  • rds_cluster_snapshot_id (String) Target DB Cluster snapshot ID
  • source_rds_cluster_id (String) Target DB Cluster ID

Nested Schema for copy_rds_snapshot_action_value

Required:

  • destination_region (String) AWS Region to copy to
  • source_region (String) AWS Region from which the copy was made
  • specify_rds_snapshot (String) How to identify target resources
  • trace_status (String) Whether to Verify completion status of the resource

Optional:

  • option_group_name (String) Option group name to be set for the destination region
  • rds_snapshot_id (String) Target DB snapshot ID
  • source_rds_instance_id (String) Target RDS instance ID

Nested Schema for create_ebs_snapshot_action_value

Required:

  • generation (Number) Number of EBS volumes to manage generation
  • region (String) AWS Region in which the target resource resides
  • specify_volume (String) How to identify target resources

Optional:

  • additional_tag_key (String) Tag key to assign to the created EBS volume
  • additional_tag_value (String) Tag key to assign to the created EBS volume Tag value to assign to the created EBS volume
  • additional_tags (Block Set) Array of tags to assign to the created EBS volume (see below for nested schema)
  • description (String) Description to be set for EBS volume
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • trace_status (String) Whether to Verify completion status of the resource
  • volume_id (String) 対象のEBSボリュームID

Nested Schema for create_ebs_snapshot_action_value.additional_tags

Required:

  • key (String)
  • value (String)

Nested Schema for create_fsx_backup_action_value

Required:

  • generation (Number) Number of EBS volumes to manage generation
  • region (String) AWS Region in which the target resource resides
  • specify_file_system (String) How to identify target resources

Optional:

  • backup_name (String) Backup name
  • file_system_id (String) Target Filesystem snapshot ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource

Nested Schema for create_image_action_value

Required:

  • generation (Number) Number of AMI generations to be managed
  • image_name (String) Image name to set for AMI
  • reboot_instance (String) Flag whether or not to restart the instance when creating an AMI
  • region (String) AWS Region in which the target resource resides
  • specify_image_instance (String) How to identify target resources

Optional:

  • add_same_tag_to_snapshot (String) Whether to add the tags assigned to the AMI to the EBS snapshot as well
  • additional_tag_key (String) Tag key to assign to the created AMI
  • additional_tag_value (String) Tag value to assign to the created AMI
  • additional_tags (Block Set) Array of tags to assign to the created AMI (see below for nested schema)
  • description (String) Description to be set in AMI
  • instance_id (String) Target EC2 instance ID
  • recreate_image_if_ami_status_failed (String) Whether or not to retry when a job fails
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • trace_status (String) Whether to Verify completion status of the resource

Nested Schema for create_image_action_value.additional_tags

Required:

  • key (String)
  • value (String)

Nested Schema for create_nat_gateway_action_value

Required:

  • additional_tags (Block Set, Min: 1) Array of tags to be assigned to the NAT Gateway (see below for nested schema)
  • allocation_id (String) Allocation ID of the Elastic IP to assign to the NAT Gateway
  • region (String) AWS Region where the NAT Gateway will be created
  • route_table_id (String) Route table ID to add a route targeting the NAT Gateway
  • subnet_id (String) Subnet ID where the NAT Gateway will be created

Optional:

  • nat_gateway_name (String) Name tag value for the NAT Gateway

Nested Schema for create_nat_gateway_action_value.additional_tags

Required:

  • key (String)
  • value (String)

Nested Schema for create_rds_cluster_snapshot_action_value

Required:

  • db_cluster_snapshot_identifier (String) Prefix for DB cluster snapshot to be created
  • generation (Number) Number of DB cluster snapshots to manage generations
  • region (String) AWS Region in which the target resource resides
  • specify_rds_cluster (String) How to identify target resources

Optional:

  • db_cluster_identifier (String) Target DB Cluster ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • trace_status (String) Whether to Verify completion status of the resource

Nested Schema for create_rds_snapshot_action_value

Required:

  • generation (Number) Number of DB snapshots generation management
  • rds_snapshot_id (String) Target DB snapshot ID
  • region (String) AWS Region in which the target resource resides
  • specify_rds_instance (String) How to identify target resources

Optional:

  • rds_instance_id (String) Target DB instance ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • trace_status (String) Whether to Verify completion status of the resource

Nested Schema for create_redshift_snapshot_action_value

Required:

  • cluster_snapshot_identifier (String) Name to be set for the snapshot
  • generation (Number) Number of snapshots to be managed for generation
  • region (String) AWS Region in which the target resource resides
  • specify_cluster (String) How to identify target resources

Optional:

  • cluster_identifier (String) Target Cluster ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • trace_status (String) Whether to Verify completion status of the resource

Nested Schema for delay_action_value

Optional:

  • delay_minutes (Number)

Nested Schema for delete_cluster_action_value

Required:

  • cluster_identifier (String) Target Redshift cluster ID
  • final_cluster_snapshot_identifier (String) Snapshot name to be taken when deleting Redshift cluster
  • region (String) AWS Region in which the target resource resides
  • skip_final_cluster_snapshot (String) Whether to skip taking snapshots when deleting Redshift clusters

Optional:

  • trace_status (String) Whether to Verify completion status of the resource

Nested Schema for delete_nat_gateway_action_value

Required:

  • region (String) AWS Region
  • tag_key (String) Tag key used to identify the target NAT Gateway
  • tag_value (String) Tag value used to identify the target NAT Gateway

Nested Schema for delete_rds_cluster_action_value

Required:

  • final_db_snapshot_identifier (String) Snapshot name to be taken when deleting DB cluster
  • region (String) AWS Region in which the target resource resides
  • skip_final_snapshot (String) Whether to skip taking snapshots when deleting DB clusters
  • specify_rds_cluster (String) How to identify target resources

Optional:

  • db_cluster_identifier (String) Target DB Cluster ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • trace_status (String) Whether to Verify completion status of the resource

Nested Schema for delete_rds_instance_action_value

Required:

  • final_rds_snapshot_id (String) DB snapshot name to be retrieved when deleting RDS instance
  • region (String) AWS Region in which the target resource resides
  • skip_final_rds_snapshot (String) Whether to skip taking DB snapshots when deleting RDS instances
  • specify_rds_instance (String) How to identify target resources

Optional:

  • rds_instance_id (String) Target DB instance ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • trace_status (String) Whether to Verify completion status of the resource

Nested Schema for deregister_instances_action_value

Required:

  • load_balancer_name (String) Name of the ELB (CLB) to unregister the EC2 instance
  • region (String) AWS Region in which the target resource resides
  • specify_instance (String) How to identify target resources

Optional:

  • instance_id (String) Target EC2 instance ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource

Nested Schema for deregister_target_instances_action_value

Required:

  • region (String) AWS Region in which the target resource resides
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • target_group_arn (String) ARN of the target group

Nested Schema for describe_metadata_action_value

Optional:

  • dr_configuration_id (Number) DR Configuration ID

Nested Schema for detach_user_policy_action_value

Required:

  • policy_arn (String) ARN of the policy to detach
  • user_name (String) Name of the user to detach the policy from

Nested Schema for disaster_recovery_action_value

Optional:

  • describe_metadata_job_id (Number) Describe Metadata Job ID
  • trace_status (String) Whether to Verify completion status of the resource

Nested Schema for dynamodb_start_backup_job_action_value

Required:

  • backup_vault_name (String) Backup Vault Name
  • dynamodb_table_name (String) Name of the DynamoDB table
  • iam_role_arn (String) IAM Role ARN
  • region (String) AWS Region

Optional:

  • additional_tags (Block Set) Array of tags to be added to the recovery point (see below for nested schema)
  • lifecycle_delete_after_days (Number) Number of days to hold recovery point

Nested Schema for dynamodb_start_backup_job_action_value.additional_tags

Required:

  • key (String)
  • value (String)

Nested Schema for ec2_start_backup_job_action_value

Required:

  • backup_vault_name (String) Backup Vault Name
  • iam_role_arn (String) IAM Role ARN
  • region (String) AWS Region
  • specify_instance (String) How to identify target resources

Optional:

  • additional_tags (Block Set) Array of tags to be added to the recovery point (see below for nested schema)
  • instance_id (String) Target EC2 instance ID
  • lifecycle_delete_after_days (Number) Number of days to hold recovery point
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource

Nested Schema for ec2_start_backup_job_action_value.additional_tags

Required:

  • key (String)
  • value (String)

Nested Schema for ecs_change_service_task_count_action_value

Required:

  • ecs_cluster (String) Target ECS cluster name
  • region (String) AWS Region
  • specify_ecs_service (String) How to identify target ECS service
  • specify_task_change (String) Task count change method

Optional:

  • desired_count (Number) ECS service desired count
  • ecs_service (String) Target ECS service name
  • max_capacity (Number) AutoScaling maximum capacity
  • min_capacity (Number) AutoScaling minimum capacity
  • tag_key (String) Tag key used to identify the target service
  • tag_value (String) Tag value used to identify the target service

Nested Schema for efs_start_backup_job_action_value

Required:

  • backup_vault_name (String) Backup Vault Name
  • file_system_id (String) Target file system ID
  • iam_role_arn (String) IAM Role ARN
  • region (String) AWS Region

Optional:

  • additional_tags (Block Set) Array of tags to be added to the recovery point (see below for nested schema)
  • lifecycle_delete_after_days (Number) Number of days to hold recovery point

Nested Schema for efs_start_backup_job_action_value.additional_tags

Required:

  • key (String)
  • value (String)

Nested Schema for google_compute_insert_machine_image_action_value

Required:

  • generation (Number) Number of machine image generations
  • machine_image_basename (String) Name of the machine image to created
  • machine_image_storage_location (String) Machine image storage location
  • project_id (String) Project ID to which the target VM instance belongs
  • region (String) GCP Region in which the target resource resides
  • specify_vm_instance (String) How to identify target resources

Optional:

  • machine_image_description (String) Description to set for machine image to created
  • vm_instance_id (String) VM Instance ID
  • vm_instance_label_key (String) label key used to identify the target resource
  • vm_instance_label_value (String) label value used to identify the target resource

Nested Schema for no_action_action_value

Nested Schema for rds_cluster_change_capacity_action_value

Required:

  • acu_max_capacity (Number) Maximum capacity
  • acu_min_capacity (Number) Minimum capacity
  • region (String) AWS Region in which the target resource resides
  • specify_rds_cluster (String) How to identify target resources

Optional:

  • db_cluster_identifier (String) Target DB Cluster ID
  • seconds_until_auto_pause (Number) Seconds until auto pause
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource

Nested Schema for reboot_rds_instances_action_value

Required:

  • region (String) AWS Region in which the target resource resides
  • specify_rds_instance (String) How to identify target resources

Optional:

  • rds_instance_id (String) Target DB instance ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource

Nested Schema for reboot_workspaces_action_value

Required:

  • region (String) AWS Region in which the target resource resides
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource

Nested Schema for rebuild_workspaces_action_value

Required:

  • region (String) AWS Region in which the target resource resides
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource

Nested Schema for register_instances_action_value

Required:

  • load_balancer_name (String) Name of the ELB (CLB) where the EC2 instance is registered
  • region (String) AWS Region in which the target resource resides
  • specify_instance (String) How to identify target resources

Optional:

  • instance_id (String) Target EC2 instance ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource

Nested Schema for register_target_instances_action_value

Required:

  • region (String) AWS Region in which the target resource resides
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • target_group_arn (String) ARN of the target group

Nested Schema for restore_from_cluster_snapshot_action_value

Required:

  • availability_zone (String) AvailabilityZone of the Redshift cluster after restore
  • cluster_identifier (String) Redshift cluster ID after restore
  • region (String) AWS Region in which the target resource resides
  • snapshot_identifier (String) Redshift snapshot ID to be used for restore

Optional:

  • allow_version_upgrade (String) Whether to enable automatic minor version upgrades on the Redshift cluster after restore
  • cluster_parameter_group_name (String) Parameter group name to be set for the restored Redshift cluster
  • cluster_subnet_group_name (String) Name of the subnet group where the restored Redshift cluster will be located
  • delete_cluster_snapshot (String) Whether to delete Redshift snapshots used for restore
  • port (Number) Port number of the DB cluster after restoration
  • publicly_accessible (String) Whether to make the restored Redshift cluster publicly accessible or not
  • vpc_security_group_ids (List of String) Array containing the security group IDs to be set for the restored Redshift cluster

Nested Schema for restore_rds_cluster_action_value

Required:

  • db_cluster_identifier (String) ID of DB cluster after restore
  • db_instance_identifier (String) ID of DB instance after restoration
  • region (String) AWS Region in which the target resource resides
  • snapshot_identifier (String) DB snapshot ID to be used for restore

Optional:

  • auto_minor_version_upgrade (String) Whether to enable automatic minor version upgrades on the DB cluster after restore
  • availability_zone (String) AZ to deploy DB cluster after restore
  • db_cluster_parameter_group_name (String) Parameter group name to be set for the DB cluster after restoration
  • db_instance_class (String) DB instance class after restore
  • db_parameter_group_name (String) Parameter group name to be set for the DB instance after restoration
  • db_subnet_group_name (String) DB subnet group name where the DB cluster will be located after restoration
  • delete_db_cluster_snapshot (String) Whether to delete DB snapshots used for restore
  • engine (String) DB engine of DB cluster after restore
  • engine_version (String) DB engine version of the DB cluster after restore
  • option_group_name (String) Option group name to be set for the DB cluster after restoration
  • port (Number) Port number of the DB cluster after restoration
  • publicly_accessible (String) Whether to make the DB cluster publicly accessible after restore
  • vpc_security_group_ids (List of String) Array containing the security group IDs to be set for the restored DB cluster

Nested Schema for restore_rds_instance_action_value

Required:

  • rds_instance_id (String) Target DB instance ID
  • rds_snapshot_id (String) Target DB snapshot ID
  • region (String) AWS Region in which the target resource resides

Optional:

  • additional_tag_key (String) Tag keys to assign to the restored RDS instance
  • additional_tag_value (String) Tag value to assign to the RDS instance after restoration
  • auto_minor_version_upgrade (String) Whether to enable automatic minor version upgrade on the RDS instance after restore
  • availability_zone (String) AZ to deploy RDS instance after restore
  • db_engine (String) DB engine of the RDS instance after restore
  • db_instance_class (String) DB instance class after restore
  • db_name (String) Database name of the restored RDS instance
  • delete_rds_snapshot (String) Whether to delete DB snapshots used for restore
  • iops (Number) IOPS value of RDS instance after restore
  • license_model (String) Licensing model of the RDS instance after restore
  • multi_az (String) Whether or not to configure the RDS instance in a Multi-AZ configuration after restoration
  • option_group (String) Option group name to be set for the restored RDS instance
  • parameter_group (String) Parameter group name to be set for the restored RDS instance
  • port (Number) Port number of the RDS instance after restoration
  • publicly_accessible (String) Whether to make the restored RDS instance publicly accessible or not
  • storage_type (String) Storage type of the RDS instance after restore
  • subnet_group (String) DB subnet group name where the restored RDS instance will be located
  • trace_status (String) Whether to Verify completion status of the resource
  • vpc (String) ID of the VPC where the RDS instance will be placed after restoration
  • vpc_security_group_ids (List of String) Array containing the security group IDs to be set for the restored RDS instance

Nested Schema for revoke_security_group_ingress_action_value

Required:

  • cidr_ip (String) CIDR IP
  • ip_protocol (String) IP protocol
  • region (String) AWS Region in which the target resource resides
  • specify_security_group (String) How to identify target resources
  • to_port (String) port

Optional:

  • security_group_id (String) Target security group ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource

Nested Schema for run_ecs_tasks_fargate_action_value

Required:

  • ecs_awsvpc_assign_public_ip (String) ECS awsvpc assign public ip
  • ecs_awsvpc_security_groups (List of String) ECS awsvpc security groups
  • ecs_awsvpc_subnets (List of String) ECS awsvpc subnets
  • ecs_awsvpc_vpc (String) ECS awsvpc vpc
  • ecs_cluster (String) ECS cluster name
  • ecs_task_count (Number) Number of ECS tasks to run
  • ecs_task_definition_family (String) ECS task definition family
  • enable_ecs_managed_tags (Boolean) Enable ECS managed tags
  • platform_version (String) Platform version
  • propagate_tags (String) Propagate tags
  • region (String) AWS Region in which the target resource resides

Nested Schema for s3_start_backup_job_action_value

Required:

  • backup_vault_name (String) Name of the backup vault to store the backup
  • bucket_name (String) Name of the S3 bucket to store the backup
  • iam_role_arn (String) ARN of the IAM role to use for the backup
  • region (String) AWS Region in which the target resource resides

Optional:

  • additional_tags (Block Set) Additional tags to be added to the backup (see below for nested schema)
  • lifecycle_delete_after_days (Number) Number of days to keep the backup

Nested Schema for s3_start_backup_job_action_value.additional_tags

Required:

  • key (String)
  • value (String)

Nested Schema for send_command_action_value

Required:

  • command (String) Commands to execute
  • document_name (String) Command Type
  • region (String) AWS Region in which the target resource resides
  • specify_instance (String) How to identify target resources

Optional:

  • comment (String) Comments to be set for the command
  • execution_timeout_seconds (String) Timeout period for command execution (seconds)
  • instance_id (String) Target EC2 instance ID
  • output_s3_bucket_name (String) Name of the S3 bucket in which to store the execution results
  • output_s3_key_prefix (String) S3 prefix to store execution results
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • timeout_seconds (String) Instance connection timeout time (seconds)
  • trace_status (String) Whether to Verify completion status of the resource

Nested Schema for start_instances_action_value

Required:

  • region (String) AWS Region in which the target resource resides
  • specify_instance (String) How to identify target resources

Optional:

  • instance_id (String) Target EC2 instance ID
  • status_checks_enable (String) Whether status check is performed or not. Can be true only if true is specified in trace_status
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • trace_status (String) Whether to Verify completion status of the resource

Nested Schema for start_rds_clusters_action_value

Required:

  • region (String) AWS Region in which the target resource resides
  • specify_rds_cluster (String) How to identify target resources

Optional:

  • db_cluster_identifier (String) Target DB Cluster ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • trace_status (String) Whether to Verify completion status of the resource

Nested Schema for start_rds_instances_action_value

Required:

  • region (String) AWS Region in which the target resource resides
  • specify_rds_instance (String) How to identify target resources

Optional:

  • rds_instance_id (String) Target DB instance ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • trace_status (String) Whether to Verify completion status of the resource

Nested Schema for start_workspaces_action_value

Required:

  • region (String) AWS Region in which the target resource resides

Optional:

  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource

Nested Schema for stop_ecs_tasks_action_value

Required:

  • ecs_cluster (String) Target ECS cluster name
  • region (String) AWS Region in which the target resource resides
  • specify_ecs_task (String) How to identify target resources

Optional:

  • ecs_task_definition_family (String) ECS task definition family name
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource

Nested Schema for stop_instances_action_value

Required:

  • region (String) AWS Region in which the target resource resides
  • specify_instance (String) How to identify target resources

Optional:

  • instance_id (String) Target EC2 instance ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • trace_status (String) Whether to Verify completion status of the resource

Nested Schema for stop_rds_clusters_action_value

Required:

  • region (String) AWS Region in which the target resource resides
  • specify_rds_cluster (String) How to identify target resources

Optional:

  • db_cluster_identifier (String) Target DB Cluster ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • trace_status (String) Whether to Verify completion status of the resource

Nested Schema for stop_rds_instances_action_value

Required:

  • region (String) AWS Region in which the target resource resides
  • specify_rds_instance (String) How to identify target resources

Optional:

  • rds_instance_id (String) Target DB instance ID
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • trace_status (String) Whether to Verify completion status of the resource

Nested Schema for terminate_workspaces_action_value

Required:

  • region (String) AWS Region in which the target resource resides
  • specify_workspace (String) How to identify target resources

Optional:

  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • trace_status (String) Whether to Verify completion status of the resource

Nested Schema for update_record_set_action_value

Required:

  • record_set_name (String) Resource record set to be updated
  • record_set_type (String) Resource record type
  • record_set_value (String) Resource Record Set Value
  • zone_name (String) Host zone for updating the resource record set

Nested Schema for vault_recovery_point_start_copy_job_action_value

Required:

  • iam_role_arn (String) IAM Role ARN to use when creating the copy
  • resource_id (String) ID of resource to copy recovery point
  • resource_type (String) Type of resource to copy recovery point
  • source_backup_vault_name (String) Source backup vault name
  • source_region (String) Region where the source backup vault is located
  • specify_destination_aws_account (String) How to specify the destination AWS account

Optional:

  • destination_backup_vault_arn (String) ARN of the destination backup vault
  • destination_backup_vault_name (String) Destination backup vault name
  • destination_region (String) Region where the destination backup vault is located
  • lifecycle_delete_after_days (Number) Copy retention period (days)

Nested Schema for windows_update_action_value

Required:

  • document_name (String) AWS-InstallMissingWindowsUpdates 固定
  • region (String) AWS Region in which the target resource resides
  • specify_instance (String) How to identify target resources
  • update_level (String) Update Level

Optional:

  • comment (String) Comments to be set for the command
  • instance_id (String) Target EC2 instance ID
  • kb_article_ids (String) Array containing KB to be excluded
  • output_s3_bucket_name (String) Name of the S3 bucket in which to store the execution results
  • output_s3_key_prefix (String) S3 prefix to store execution results
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • timeout_seconds (String) Timeout time (sec)

Nested Schema for windows_update_v2_action_value

Required:

  • allow_reboot (String) Whether to allow reboots caused by applying Windows Update
  • region (String) AWS Region in which the target resource resides
  • specify_instance (String) How to identify target resources
  • specify_severity (String) How to identify target resources

Optional:

  • instance_id (String) Target EC2 instance ID
  • output_s3_bucket_name (String) Name of the S3 bucket in which to store the execution results
  • output_s3_key_prefix (String) S3 prefix to store execution results
  • severity_levels (List of String) Severity of Windows Update to be applied
  • tag_key (String) Tag key used to identify the target resource
  • tag_value (String) Tag value used to identify the target resource
  • trace_status (String) Whether to Verify completion status of the resource

Nested Schema for cron_rule_value

Read-Only:

  • dates_to_skip (List of String)
  • hour (String)
  • minutes (String)
  • monthly_day_of_week_schedule (List of Object) (see below for nested schema)
  • monthly_schedule (String)
  • national_holiday_schedule (String)
  • one_time_schedule (String)
  • schedule_type (String)
  • start_timeout_minutes (String)
  • time_zone (String)
  • weekly_schedule (List of String)

Nested Schema for cron_rule_value.monthly_day_of_week_schedule

Read-Only:

  • friday (List of Number)
  • monday (List of Number)
  • saturday (List of Number)
  • sunday (List of Number)
  • thursday (List of Number)
  • tuesday (List of Number)
  • wednesday (List of Number)

Nested Schema for schedule_rule_value

Read-Only:

  • schedule (String)
  • time_zone (String)

Nested Schema for sqs_v2_rule_value

Read-Only:

  • queue (String)
  • sqs_aws_account_id (Number)
  • sqs_region (String)