LifecyclePolicyPolicyDetails class
Constructors
-
LifecyclePolicyPolicyDetails({Input<LifecyclePolicyPolicyDetailsAction?>? action, Input<bool?>? copyTags, Input<int?>? createInterval, Input<LifecyclePolicyPolicyDetailsEventSource?>? eventSource, Input<LifecyclePolicyPolicyDetailsExclusions?>? exclusions, Input<bool?>? extendDeletion, Input<LifecyclePolicyPolicyDetailsParameters?>? parameters, Input<String?>? policyLanguage, Input<String?>? policyType, Input<String?>? resourceLocations, Input<String?>? resourceType, Input<List<String>?>? resourceTypes, Input<int?>? retainInterval, Input<List<LifecyclePolicyPolicyDetailsSchedule>?>? schedules, Input<Map<String, String>?>? targetTags})
-
Creates a new LifecyclePolicyPolicyDetails.
action The actions to be performed when the event-based policy is triggered. You can specify only one action per policy. This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter. See the action configuration block.
copyTags Optional.
createInterval How often the policy should run and create snapshots or AMIs. valid values range from 1 to 7. Default value is 1.
eventSource The event that triggers the event-based policy. This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter. See the eventSource configuration block.
exclusions Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. See the exclusions configuration block.
extendDeletion 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. Default value is false.
parameters Optional.
policyLanguage Type of policy to create. SIMPLIFIED To create a default policy. STANDARD To create a custom policy.
policyType 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 AWS account. Default value is EBS_SNAPSHOT_MANAGEMENT.
resourceLocations The location of the resources to backup. If the source resources are located in an AWS Region, specify CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST. If the source resources are located in a Local Zone, specify LOCAL_ZONE. Valid values are CLOUD, LOCAL_ZONE, and OUTPOST.
resourceType Type of default policy to create. Valid values are VOLUME and INSTANCE.
resourceTypes A list of resource types that should be targeted by the lifecycle policy. Valid values are VOLUME and INSTANCE.
retainInterval Specifies how long the policy should retain snapshots or AMIs before deleting them. valid values range from 2 to 14. Default value is 7.
schedules See the schedule configuration block.
targetTags A map of tag keys and their values. Any resources that match the resourceTypes and are tagged with any of these tags will be targeted. Required when policyType is EBS_SNAPSHOT_MANAGEMENT or IMAGE_MANAGEMENT. Must not be specified when policyType is EVENT_BASED_POLICY.
const
-
LifecyclePolicyPolicyDetails.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
action
→ Input<LifecyclePolicyPolicyDetailsAction?>?
-
The actions to be performed when the event-based policy is triggered. You can specify only one action per policy. This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter. See the
action configuration block.
final
-
copyTags
→ Input<bool?>?
-
final
-
createInterval
→ Input<int?>?
-
How often the policy should run and create snapshots or AMIs. valid values range from
1 to 7. Default value is 1.
final
-
eventSource
→ Input<LifecyclePolicyPolicyDetailsEventSource?>?
-
The event that triggers the event-based policy. This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter. See the
eventSource configuration block.
final
-
exclusions
→ Input<LifecyclePolicyPolicyDetailsExclusions?>?
-
Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. See the
exclusions configuration block.
final
-
extendDeletion
→ Input<bool?>?
-
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. Default value is
false.
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
parameters
→ Input<LifecyclePolicyPolicyDetailsParameters?>?
-
final
-
policyLanguage
→ Input<String?>?
-
Type of policy to create.
SIMPLIFIED To create a default policy. STANDARD To create a custom policy.
final
-
policyType
→ Input<String?>?
-
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 AWS account. Default value is EBS_SNAPSHOT_MANAGEMENT.
final
-
resourceLocations
→ Input<String?>?
-
The location of the resources to backup. If the source resources are located in an AWS Region, specify
CLOUD. If the source resources are located on an Outpost in your account, specify OUTPOST. If the source resources are located in a Local Zone, specify LOCAL_ZONE. Valid values are CLOUD, LOCAL_ZONE, and OUTPOST.
final
-
resourceType
→ Input<String?>?
-
Type of default policy to create. Valid values are
VOLUME and INSTANCE.
final
-
resourceTypes
→ Input<List<String>?>?
-
A list of resource types that should be targeted by the lifecycle policy. Valid values are
VOLUME and INSTANCE.
final
-
retainInterval
→ Input<int?>?
-
Specifies how long the policy should retain snapshots or AMIs before deleting them. valid values range from
2 to 14. Default value is 7.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
schedules
→ Input<List<LifecyclePolicyPolicyDetailsSchedule>?>?
-
See the
schedule configuration block.
final
-
targetTags
→ Input<Map<String, String>?>?
-
A map of tag keys and their values. Any resources that match the
resourceTypes and are tagged with any of these tags will be targeted. Required when policyType is EBS_SNAPSHOT_MANAGEMENT or IMAGE_MANAGEMENT. Must not be specified when policyType is EVENT_BASED_POLICY.
final