Class CfnLifecyclePolicyMixinProps.Jsii$Proxy
- All Implemented Interfaces:
CfnLifecyclePolicyMixinProps,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnLifecyclePolicyMixinProps
CfnLifecyclePolicyMixinProps-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.dlm.CfnLifecyclePolicyMixinProps
CfnLifecyclePolicyMixinProps.Builder, CfnLifecyclePolicyMixinProps.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor that initializes the object based on literal property values passed by theCfnLifecyclePolicyMixinProps.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNodefinal booleanfinal Object[Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.final Number[Default policies only] Specifies how often the policy should run and create snapshots or AMIs.final Object[Default policies only] Specifies destination Regions for snapshot or AMI copies.final String[Default policies only] Specify the type of default policy to create.final StringA description of the lifecycle policy.final Object[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs.final StringThe Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.final Object[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.final ObjectThe configuration details of the lifecycle policy.final Number[Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them.final StringgetState()The activation state of the lifecycle policy.getTags()The tags to apply to the lifecycle policy during creation.final inthashCode()Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnLifecyclePolicyMixinProps.Builder.
-
-
Method Details
-
getCopyTags
Description copied from interface:CfnLifecyclePolicyMixinProps[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
Returns union: either
BooleanorIResolvable- Specified by:
getCopyTagsin interfaceCfnLifecyclePolicyMixinProps- See Also:
-
getCreateInterval
Description copied from interface:CfnLifecyclePolicyMixinProps[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
- Specified by:
getCreateIntervalin interfaceCfnLifecyclePolicyMixinProps- See Also:
-
getCrossRegionCopyTargets
Description copied from interface:CfnLifecyclePolicyMixinProps[Default policies only] Specifies destination Regions for snapshot or AMI copies.You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.
- Specified by:
getCrossRegionCopyTargetsin interfaceCfnLifecyclePolicyMixinProps- See Also:
-
getDefaultPolicy
Description copied from interface:CfnLifecyclePolicyMixinProps[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.
- Specified by:
getDefaultPolicyin interfaceCfnLifecyclePolicyMixinProps- See Also:
- To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify
-
getDescription
Description copied from interface:CfnLifecyclePolicyMixinPropsA description of the lifecycle policy.The characters ^[0-9A-Za-z _-]+$ are supported.
- Specified by:
getDescriptionin interfaceCfnLifecyclePolicyMixinProps- See Also:
-
getExclusions
Description copied from interface:CfnLifecyclePolicyMixinProps[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.
Returns union: either
IResolvableorCfnLifecyclePolicyPropsMixin.ExclusionsProperty- Specified by:
getExclusionsin interfaceCfnLifecyclePolicyMixinProps- See Also:
-
getExecutionRoleArn
Description copied from interface:CfnLifecyclePolicyMixinPropsThe Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.- Specified by:
getExecutionRoleArnin interfaceCfnLifecyclePolicyMixinProps- See Also:
-
getExtendDeletion
Description copied from interface:CfnLifecyclePolicyMixinProps[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
Returns union: either
BooleanorIResolvable- Specified by:
getExtendDeletionin interfaceCfnLifecyclePolicyMixinProps- See Also:
- 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
-
getPolicyDetails
Description copied from interface:CfnLifecyclePolicyMixinPropsThe configuration details of the lifecycle policy.If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.
Returns union: either
IResolvableorCfnLifecyclePolicyPropsMixin.PolicyDetailsProperty- Specified by:
getPolicyDetailsin interfaceCfnLifecyclePolicyMixinProps- See Also:
-
getRetainInterval
Description copied from interface:CfnLifecyclePolicyMixinProps[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
- Specified by:
getRetainIntervalin interfaceCfnLifecyclePolicyMixinProps- See Also:
-
getState
Description copied from interface:CfnLifecyclePolicyMixinPropsThe activation state of the lifecycle policy.- Specified by:
getStatein interfaceCfnLifecyclePolicyMixinProps- See Also:
-
getTags
Description copied from interface:CfnLifecyclePolicyMixinPropsThe tags to apply to the lifecycle policy during creation.- Specified by:
getTagsin interfaceCfnLifecyclePolicyMixinProps- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-