Package software.amazon.awscdk.services.dlm

Class CfnLifecyclePolicy.PolicyDetailsProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.dlm.CfnLifecyclePolicy.PolicyDetailsProperty.Jsii$Proxy

All Implemented Interfaces:

CfnLifecyclePolicy.PolicyDetailsProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnLifecyclePolicy.PolicyDetailsProperty

@Stability(Stable)
@Internal
public static final class CfnLifecyclePolicy.PolicyDetailsProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnLifecyclePolicy.PolicyDetailsProperty

An implementation for CfnLifecyclePolicy.PolicyDetailsProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.dlm.CfnLifecyclePolicy.PolicyDetailsProperty

CfnLifecyclePolicy.PolicyDetailsProperty.Builder, CfnLifecyclePolicy.PolicyDetailsProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnLifecyclePolicy.PolicyDetailsProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnLifecyclePolicy.PolicyDetailsProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getActions()	[Event-based policies only] The actions to be performed when the event-based policy is activated.
final Object	getCopyTags()	[Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.
final Number	getCreateInterval()	[Default policies only] Specifies how often the policy should run and create snapshots or AMIs.
final Object	getCrossRegionCopyTargets()	[Default policies only] Specifies destination Regions for snapshot or AMI copies.
final Object	getEventSource()	[Event-based policies only] The event that activates the event-based policy.
final Object	getExclusions()	[Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs.
final Object	getExtendDeletion()	[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 Object	getParameters()	[Custom snapshot and AMI policies only] A set of optional parameters for snapshot and AMI lifecycle policies.
final String	getPolicyLanguage()	The type of policy to create.
final String	getPolicyType()	The type of policy.
final List<String>	getResourceLocations()	[Custom snapshot and AMI policies only] The location of the resources to backup.
final String	getResourceType()	[Default policies only] Specify the type of default policy to create.
final List<String>	getResourceTypes()	[Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies.
final Number	getRetainInterval()	[Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them.
final Object	getSchedules()	[Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies.
final Object	getTargetTags()	[Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

protected Jsii$Proxy(CfnLifecyclePolicy.PolicyDetailsProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnLifecyclePolicy.PolicyDetailsProperty.Builder.

Method Details

getActions

public final Object getActions()

Description copied from interface: CfnLifecyclePolicy.PolicyDetailsProperty

[Event-based policies only] The actions to be performed when the event-based policy is activated.

You can specify only one action per policy.

Specified by:

getActions in interface CfnLifecyclePolicy.PolicyDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-actions

getCopyTags

public final Object getCopyTags()

Description copied from interface: CfnLifecyclePolicy.PolicyDetailsProperty

[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

Specified by:

getCopyTags in interface CfnLifecyclePolicy.PolicyDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-copytags

getCreateInterval

public final Number getCreateInterval()

Description copied from interface: CfnLifecyclePolicy.PolicyDetailsProperty

[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:

getCreateInterval in interface CfnLifecyclePolicy.PolicyDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-createinterval

getCrossRegionCopyTargets

public final Object getCrossRegionCopyTargets()

Description copied from interface: CfnLifecyclePolicy.PolicyDetailsProperty

[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:

getCrossRegionCopyTargets in interface CfnLifecyclePolicy.PolicyDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-crossregioncopytargets

getEventSource

public final Object getEventSource()

Description copied from interface: CfnLifecyclePolicy.PolicyDetailsProperty

[Event-based policies only] The event that activates the event-based policy.

Specified by:

getEventSource in interface CfnLifecyclePolicy.PolicyDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-eventsource

getExclusions

public final Object getExclusions()

Description copied from interface: CfnLifecyclePolicy.PolicyDetailsProperty

[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.

Specified by:

getExclusions in interface CfnLifecyclePolicy.PolicyDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-exclusions

getExtendDeletion

public final Object getExtendDeletion()

Description copied from interface: CfnLifecyclePolicy.PolicyDetailsProperty

[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

Specified by:

getExtendDeletion in interface CfnLifecyclePolicy.PolicyDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-extenddeletion

getParameters

public final Object getParameters()

Description copied from interface: CfnLifecyclePolicy.PolicyDetailsProperty

[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.

Specified by:

getParameters in interface CfnLifecyclePolicy.PolicyDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-parameters

getPolicyLanguage

public final String getPolicyLanguage()

Description copied from interface: CfnLifecyclePolicy.PolicyDetailsProperty

The type of policy to create. Specify one of the following:.

• SIMPLIFIED To create a default policy.
• STANDARD To create a custom policy.

Specified by:

getPolicyLanguage in interface CfnLifecyclePolicy.PolicyDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-policylanguage

getPolicyType

public final String getPolicyType()

Description copied from interface: CfnLifecyclePolicy.PolicyDetailsProperty

The type of policy.

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 .

The default is EBS_SNAPSHOT_MANAGEMENT .

Specified by:

getPolicyType in interface CfnLifecyclePolicy.PolicyDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-policytype

getResourceLocations

public final List<String> getResourceLocations()

Description copied from interface: CfnLifecyclePolicy.PolicyDetailsProperty

[Custom snapshot and AMI policies only] 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 you specify OUTPOST , Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.

Specified by:

getResourceLocations in interface CfnLifecyclePolicy.PolicyDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-resourcelocations

getResourceType

public final String getResourceType()

Description copied from interface: CfnLifecyclePolicy.PolicyDetailsProperty

[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:

getResourceType in interface CfnLifecyclePolicy.PolicyDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-resourcetype

getResourceTypes

public final List<String> getResourceTypes()

Description copied from interface: CfnLifecyclePolicy.PolicyDetailsProperty

[Custom snapshot policies only] The target resource type for snapshot and AMI lifecycle policies.

Use VOLUME to create snapshots of individual volumes or use INSTANCE to create multi-volume snapshots from the volumes for an instance.

Specified by:

getResourceTypes in interface CfnLifecyclePolicy.PolicyDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-resourcetypes

getRetainInterval

public final Number getRetainInterval()

Description copied from interface: CfnLifecyclePolicy.PolicyDetailsProperty

[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:

getRetainInterval in interface CfnLifecyclePolicy.PolicyDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-retaininterval

getSchedules

public final Object getSchedules()

Description copied from interface: CfnLifecyclePolicy.PolicyDetailsProperty

[Custom snapshot and AMI policies only] The schedules of policy-defined actions for snapshot and AMI lifecycle policies.

A policy can have up to four schedules—one mandatory schedule and up to three optional schedules.

Specified by:

getSchedules in interface CfnLifecyclePolicy.PolicyDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-schedules

getTargetTags

public final Object getTargetTags()

Description copied from interface: CfnLifecyclePolicy.PolicyDetailsProperty

[Custom snapshot and AMI policies only] The single tag that identifies targeted resources for this policy.

Specified by:

getTargetTags in interface CfnLifecyclePolicy.PolicyDetailsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dlm-lifecyclepolicy-policydetails.html#cfn-dlm-lifecyclepolicy-policydetails-targettags

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object