_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
policy
Detailed information about the lifecycle policy. | STRUCT(
"policy_id" VARCHAR,
"description" VARCHAR,
"state" VARCHAR,
"status_message" VARCHAR,
"execution_role_arn" VARCHAR,
"date_created" TIMESTAMP_S,
"date_modified" TIMESTAMP_S,
"policy_details" STRUCT(
"policy_type" VARCHAR,
"resource_types" VARCHAR[],
"resource_locations" VARCHAR[],
"target_tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"schedules" STRUCT(
"name" VARCHAR,
"copy_tags" BOOLEAN,
"tags_to_add" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"variable_tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"create_rule" STRUCT(
"location" VARCHAR,
"interval" BIGINT,
"interval_unit" VARCHAR,
"times" VARCHAR[],
"cron_expression" VARCHAR,
"scripts" STRUCT(
"stages" VARCHAR[],
"execution_handler_service" VARCHAR,
"execution_handler" VARCHAR,
"execute_operation_on_script_failure" BOOLEAN,
"execution_timeout" BIGINT,
"maximum_retry_count" BIGINT
)[]
),
"retain_rule" STRUCT(
"count" BIGINT,
"interval" BIGINT,
"interval_unit" VARCHAR
),
"fast_restore_rule" STRUCT(
"count" BIGINT,
"interval" BIGINT,
"interval_unit" VARCHAR,
"availability_zones" VARCHAR[]
),
"cross_region_copy_rules" STRUCT(
"target_region" VARCHAR,
"target" VARCHAR,
"encrypted" BOOLEAN,
"cmk_arn" VARCHAR,
"copy_tags" BOOLEAN,
"retain_rule" STRUCT(
"interval" BIGINT,
"interval_unit" VARCHAR
),
"deprecate_rule" STRUCT(
"interval" BIGINT,
"interval_unit" VARCHAR
)
)[],
"share_rules" STRUCT(
"target_accounts" VARCHAR[],
"unshare_interval" BIGINT,
"unshare_interval_unit" VARCHAR
)[],
"deprecate_rule" STRUCT(
"count" BIGINT,
"interval" BIGINT,
"interval_unit" VARCHAR
),
"archive_rule" STRUCT(
"retain_rule" STRUCT(
"retention_archive_tier" STRUCT(
"count" BIGINT,
"interval" BIGINT,
"interval_unit" VARCHAR
)
)
)
)[],
"parameters" STRUCT(
"exclude_boot_volume" BOOLEAN,
"no_reboot" BOOLEAN,
"exclude_data_volume_tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
),
"event_source" STRUCT(
"type" VARCHAR,
"parameters" STRUCT(
"event_type" VARCHAR,
"snapshot_owner" VARCHAR[],
"description_regex" VARCHAR
)
),
"actions" STRUCT(
"name" VARCHAR,
"cross_region_copy" STRUCT(
"target" VARCHAR,
"encryption_configuration" STRUCT(
"encrypted" BOOLEAN,
"cmk_arn" VARCHAR
),
"retain_rule" STRUCT(
"interval" BIGINT,
"interval_unit" VARCHAR
)
)[]
)[],
"policy_language" VARCHAR,
"resource_type" VARCHAR,
"create_interval" BIGINT,
"retain_interval" BIGINT,
"copy_tags" BOOLEAN,
"cross_region_copy_targets" STRUCT(
"target_region" VARCHAR
)[],
"extend_deletion" BOOLEAN,
"exclusions" STRUCT(
"exclude_boot_volumes" BOOLEAN,
"exclude_volume_types" VARCHAR[],
"exclude_tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)
),
"tags" MAP(VARCHAR, VARCHAR),
"policy_arn" VARCHAR,
"default_policy" BOOLEAN
) |
Show child fields- policy.date_created
The local date and time when the lifecycle policy was created. - policy.date_modified
The local date and time when the lifecycle policy was last modified. - policy.default_policy
[Default policies only] The type of default policy. Values include: - policy.description
The description of the lifecycle policy. - policy.execution_role_arn
The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy. - policy.policy_arn
The Amazon Resource Name (ARN) of the policy. - policy.policy_details
The configuration of the lifecycle policy Show child fields- policy.policy_details.actions[]
Show child fields- policy.policy_details.actions[].cross_region_copy[]
Show child fields- policy.policy_details.actions[].cross_region_copy[].encryption_configuration
The encryption settings for the copied snapshot. Show child fields- policy.policy_details.actions[].cross_region_copy[].encryption_configuration.cmk_arn
The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used. - policy.policy_details.actions[].cross_region_copy[].encryption_configuration.encrypted
To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when encryption by default is not enabled.
- policy.policy_details.actions[].cross_region_copy[].retain_rule
Specifies a retention rule for cross-Region snapshot copies created by snapshot or event-based policies, or cross-Region AMI copies created by AMI policies. After the retention period expires, the cross-Region copy is deleted. Show child fields- policy.policy_details.actions[].cross_region_copy[].retain_rule.interval
The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days. - policy.policy_details.actions[].cross_region_copy[].retain_rule.interval_unit
The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.
- policy.policy_details.actions[].cross_region_copy[].target
The target Region.
- policy.policy_details.actions[].name
A descriptive name for the action.
- policy.policy_details.copy_tags
[Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false. Default: false - policy.policy_details.create_interval
[Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1. Default: 1 - policy.policy_details.cross_region_copy_targets[]
Show child fields- policy.policy_details.cross_region_copy_targets[].target_region
The target Region, for example us-east-1.
- policy.policy_details.event_source
[Event-based policies only] The event that activates the event-based policy. Show child fields- policy.policy_details.event_source.parameters
Information about the event. Show child fields- policy.policy_details.event_source.parameters.description_regex
The snapshot description that can trigger the policy. The description pattern is specified using a regular expression. The policy runs only if a snapshot with a description that matches the specified pattern is shared with your account. For example, specifying ^.*Created for policy: policy-1234567890abcdef0.*$ configures the policy to run only if snapshots created by policy policy-1234567890abcdef0 are shared with your account. - policy.policy_details.event_source.parameters.event_type
The type of event. Currently, only snapshot sharing events are supported. - policy.policy_details.event_source.parameters.snapshot_owner[]
- policy.policy_details.event_source.type
The source of the event. Currently only managed CloudWatch Events rules are supported.
- policy.policy_details.exclusions
[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters. Show child fields- policy.policy_details.exclusions.exclude_boot_volumes
[Default policies for EBS snapshots only] Indicates whether to exclude volumes that are attached to instances as the boot volume. If you exclude boot volumes, only volumes attached as data (non-boot) volumes will be backed up by the policy. To exclude boot volumes, specify true. - policy.policy_details.exclusions.exclude_tags[]
Show child fields- policy.policy_details.exclusions.exclude_tags[].key
The tag key. - policy.policy_details.exclusions.exclude_tags[].value
The tag value.
- policy.policy_details.exclusions.exclude_volume_types[]
- policy.policy_details.extend_deletion
[Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state. By default (ExtendDeletion=false): -
If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true. -
If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true. If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously. If you do not specify a value, the default is false. Default: false - policy.policy_details.parameters
[Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies. If you are modifying a policy that was created or previously modified using the Amazon Data Lifecycle Manager console, then you must include this parameter and specify either the default values or the new values that you require. You can't omit this parameter or set its values to null. Show child fields- policy.policy_details.parameters.exclude_boot_volume
[Custom snapshot policies that target instances only] Indicates whether to exclude the root volume from multi-volume snapshot sets. The default is false. If you specify true, then the root volumes attached to targeted instances will be excluded from the multi-volume snapshot sets created by the policy. - policy.policy_details.parameters.exclude_data_volume_tags[]
Show child fields- policy.policy_details.parameters.exclude_data_volume_tags[].key
The tag key. - policy.policy_details.parameters.exclude_data_volume_tags[].value
The tag value.
- policy.policy_details.parameters.no_reboot
[Custom AMI policies only] Indicates whether targeted instances are rebooted when the lifecycle policy runs. true indicates that targeted instances are not rebooted when the policy runs. false indicates that target instances are rebooted when the policy runs. The default is true (instances are not rebooted).
- policy.policy_details.policy_language
The type of policy to create. Specify one of the following: - policy.policy_details.policy_type
[Custom policies only] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account. The default is EBS_SNAPSHOT_MANAGEMENT. - policy.policy_details.resource_locations[]
- policy.policy_details.resource_type
[Default policies only] Specify the type of default policy to create. -
To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME. -
To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE. - policy.policy_details.resource_types[]
- policy.policy_details.retain_interval
[Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7. Default: 7 - policy.policy_details.schedules[]
Show child fields- policy.policy_details.schedules[].archive_rule
[Custom snapshot policies that target volumes only] The snapshot archiving rule for the schedule. When you specify an archiving rule, snapshots are automatically moved from the standard tier to the archive tier once the schedule's retention threshold is met. Snapshots are then retained in the archive tier for the archive retention period that you specify. For more information about using snapshot archiving, see Considerations for snapshot lifecycle policies. Show child fields- policy.policy_details.schedules[].archive_rule.retain_rule
Information about the retention period for the snapshot archiving rule. Show child fields- policy.policy_details.schedules[].archive_rule.retain_rule.retention_archive_tier
Information about retention period in the Amazon EBS Snapshots Archive. For more information, see Archive Amazon EBS snapshots. Show child fields- policy.policy_details.schedules[].archive_rule.retain_rule.retention_archive_tier.count
The maximum number of snapshots to retain in the archive storage tier for each volume. The count must ensure that each snapshot remains in the archive tier for at least 90 days. For example, if the schedule creates snapshots every 30 days, you must specify a count of 3 or more to ensure that each snapshot is archived for at least 90 days. - policy.policy_details.schedules[].archive_rule.retain_rule.retention_archive_tier.interval
Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted. - policy.policy_details.schedules[].archive_rule.retain_rule.retention_archive_tier.interval_unit
The unit of time in which to measure the Interval. For example, to retain a snapshots in the archive tier for 6 months, specify Interval=6 and IntervalUnit=MONTHS.
- policy.policy_details.schedules[].copy_tags
Copy all user-defined tags on a source volume to snapshots of the volume created by this policy. - policy.policy_details.schedules[].create_rule
The creation rule. Show child fields- policy.policy_details.schedules[].create_rule.cron_expression
The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. For more information, see Cron expressions in the Amazon CloudWatch User Guide. - policy.policy_details.schedules[].create_rule.interval
The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24. - policy.policy_details.schedules[].create_rule.interval_unit
The interval unit. - policy.policy_details.schedules[].create_rule.location
[Custom snapshot policies only] Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify CLOUD. To create snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL. If you omit this parameter, CLOUD is used by default. If the policy targets resources in an Amazon Web Services Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost. - policy.policy_details.schedules[].create_rule.scripts[]
Show child fields- policy.policy_details.schedules[].create_rule.scripts[].execute_operation_on_script_failure
Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails. -
To default to crash consistent snapshot if the pre script fails, specify true. -
To skip the instance for snapshot creation if the pre script fails, specify false. This parameter is supported only if you run a pre script. If you run a post script only, omit this parameter. Default: true - policy.policy_details.schedules[].create_rule.scripts[].execution_handler
The SSM document that includes the pre and/or post scripts to run. -
If you are automating VSS backups, specify AWS_VSS_BACKUP. In this case, Amazon Data Lifecycle Manager automatically uses the AWSEC2-CreateVssSnapshot SSM document. -
If you are automating application-consistent snapshots for SAP HANA workloads, specify AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA. -
If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. If you are using a custom SSM document that is shared with you, specify the ARN of the SSM document. - policy.policy_details.schedules[].create_rule.scripts[].execution_handler_service
Indicates the service used to execute the pre and/or post scripts. -
If you are using custom SSM documents or automating application-consistent snapshots of SAP HANA workloads, specify AWS_SYSTEMS_MANAGER. -
If you are automating VSS Backups, omit this parameter. Default: AWS_SYSTEMS_MANAGER - policy.policy_details.schedules[].create_rule.scripts[].execution_timeout
Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. If a script does not complete within its timeout period, Amazon Data Lifecycle Manager fails the attempt. The timeout period applies to the pre and post scripts individually. If you are automating VSS Backups, omit this parameter. Default: 10 - policy.policy_details.schedules[].create_rule.scripts[].maximum_retry_count
Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail. -
If the pre script fails, Amazon Data Lifecycle Manager retries the entire snapshot creation process, including running the pre and post scripts. -
If the post script fails, Amazon Data Lifecycle Manager retries the post script only; in this case, the pre script will have completed and the snapshot might have been created. If you do not want Amazon Data Lifecycle Manager to retry failed scripts, specify 0. Default: 0 - policy.policy_details.schedules[].create_rule.scripts[].stages[]
- policy.policy_details.schedules[].create_rule.times[]
- policy.policy_details.schedules[].cross_region_copy_rules[]
Show child fields- policy.policy_details.schedules[].cross_region_copy_rules[].cmk_arn
The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this parameter is not specified, the default KMS key for the account is used. - policy.policy_details.schedules[].cross_region_copy_rules[].copy_tags
Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy. - policy.policy_details.schedules[].cross_region_copy_rules[].deprecate_rule
[Custom AMI policies only] The AMI deprecation rule for cross-Region AMI copies created by the rule. Show child fields- policy.policy_details.schedules[].cross_region_copy_rules[].deprecate_rule.interval
The period after which to deprecate the cross-Region AMI copies. The period must be less than or equal to the cross-Region AMI copy retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days. - policy.policy_details.schedules[].cross_region_copy_rules[].deprecate_rule.interval_unit
The unit of time in which to measure the Interval. For example, to deprecate a cross-Region AMI copy after 3 months, specify Interval=3 and IntervalUnit=MONTHS.
- policy.policy_details.schedules[].cross_region_copy_rules[].encrypted
To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled. - policy.policy_details.schedules[].cross_region_copy_rules[].retain_rule
The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region. Show child fields- policy.policy_details.schedules[].cross_region_copy_rules[].retain_rule.interval
The amount of time to retain a cross-Region snapshot or AMI copy. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days. - policy.policy_details.schedules[].cross_region_copy_rules[].retain_rule.interval_unit
The unit of time for time-based retention. For example, to retain a cross-Region copy for 3 months, specify Interval=3 and IntervalUnit=MONTHS.
- policy.policy_details.schedules[].cross_region_copy_rules[].target
-
Use this parameter for snapshot policies only. For AMI policies, use TargetRegion instead. [Custom snapshot policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
- policy.policy_details.schedules[].cross_region_copy_rules[].target_region
-
Use this parameter for AMI policies only. For snapshot policies, use Target instead. For snapshot policies created before the Target parameter was introduced, this parameter indicates the target Region for snapshot copies. [Custom AMI policies only] The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
- policy.policy_details.schedules[].deprecate_rule
[Custom AMI policies only] The AMI deprecation rule for the schedule. Show child fields- policy.policy_details.schedules[].deprecate_rule.count
If the schedule has a count-based retention rule, this parameter specifies the number of oldest AMIs to deprecate. The count must be less than or equal to the schedule's retention count, and it can't be greater than 1000. - policy.policy_details.schedules[].deprecate_rule.interval
If the schedule has an age-based retention rule, this parameter specifies the period after which to deprecate AMIs created by the schedule. The period must be less than or equal to the schedule's retention period, and it can't be greater than 10 years. This is equivalent to 120 months, 520 weeks, or 3650 days. - policy.policy_details.schedules[].deprecate_rule.interval_unit
The unit of time in which to measure the Interval.
- policy.policy_details.schedules[].fast_restore_rule
[Custom snapshot policies only] The rule for enabling fast snapshot restore. Show child fields- policy.policy_details.schedules[].fast_restore_rule.availability_zones[]
- policy.policy_details.schedules[].fast_restore_rule.count
The number of snapshots to be enabled with fast snapshot restore. - policy.policy_details.schedules[].fast_restore_rule.interval
The amount of time to enable fast snapshot restore. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days. - policy.policy_details.schedules[].fast_restore_rule.interval_unit
The unit of time for enabling fast snapshot restore.
- policy.policy_details.schedules[].name
The name of the schedule. - policy.policy_details.schedules[].retain_rule
The retention rule for snapshots or AMIs created by the policy. Show child fields- policy.policy_details.schedules[].retain_rule.count
The number of snapshots to retain for each volume, up to a maximum of 1000. For example if you want to retain a maximum of three snapshots, specify 3. When the fourth snapshot is created, the oldest retained snapshot is deleted, or it is moved to the archive tier if you have specified an ArchiveRule. - policy.policy_details.schedules[].retain_rule.interval
The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days. - policy.policy_details.schedules[].retain_rule.interval_unit
The unit of time for time-based retention. For example, to retain snapshots for 3 months, specify Interval=3 and IntervalUnit=MONTHS. Once the snapshot has been retained for 3 months, it is deleted, or it is moved to the archive tier if you have specified an ArchiveRule.
- policy.policy_details.schedules[].share_rules[]
Show child fields- policy.policy_details.schedules[].share_rules[].target_accounts[]
- policy.policy_details.schedules[].share_rules[].unshare_interval
The period after which snapshots that are shared with other Amazon Web Services accounts are automatically unshared. - policy.policy_details.schedules[].share_rules[].unshare_interval_unit
The unit of time for the automatic unsharing interval.
- policy.policy_details.schedules[].tags_to_add[]
Show child fields- policy.policy_details.schedules[].tags_to_add[].key
The tag key. - policy.policy_details.schedules[].tags_to_add[].value
The tag value.
- policy.policy_details.schedules[].variable_tags[]
Show child fields- policy.policy_details.schedules[].variable_tags[].key
The tag key. - policy.policy_details.schedules[].variable_tags[].value
The tag value.
- policy.policy_details.target_tags[]
Show child fields- policy.policy_details.target_tags[].key
The tag key. - policy.policy_details.target_tags[].value
The tag value.
- policy.policy_id
The identifier of the lifecycle policy. - policy.state
The activation state of the lifecycle policy. - policy.status_message
The description of the status. - policy.tags
The tags.
|