awsdlm

package
v2.83.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 9, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

README

Amazon Data Lifecycle Manager Construct Library

This module is part of the AWS Cloud Development Kit project.

import dlm "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::DLM.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnLifecyclePolicy_CFN_RESOURCE_TYPE_NAME 

func CfnLifecyclePolicy_CFN_RESOURCE_TYPE_NAME() *string

func CfnLifecyclePolicy_IsCfnElement 

func CfnLifecyclePolicy_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnLifecyclePolicy_IsCfnResource 

func CfnLifecyclePolicy_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnLifecyclePolicy_IsConstruct 

func CfnLifecyclePolicy_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func NewCfnLifecyclePolicy_Override 

func NewCfnLifecyclePolicy_Override(c CfnLifecyclePolicy, scope constructs.Construct, id *string, props *CfnLifecyclePolicyProps)

Create a new `AWS::DLM::LifecyclePolicy`.

Types

type CfnLifecyclePolicy 

type CfnLifecyclePolicy interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The Amazon Resource Name (ARN) of the lifecycle policy.
	AttrArn() *string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// A description of the lifecycle policy.
	//
	// The characters ^[0-9A-Za-z _-]+$ are supported.
	Description() *string
	SetDescription(val *string)
	// The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
	ExecutionRoleArn() *string
	SetExecutionRoleArn(val *string)
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The tree node.
	Node() constructs.Node
	// The configuration details of the lifecycle policy.
	PolicyDetails() interface{}
	SetPolicyDetails(val interface{})
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// The activation state of the lifecycle policy.
	State() *string
	SetState(val *string)
	// The tags to apply to the lifecycle policy during creation.
	Tags() awscdk.TagManager
	// Deprecated.
	// Deprecated: use `updatedProperties`
	//
	// Return properties modified after initiation
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperties() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependency(target awscdk.CfnResource)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	// Deprecated: use addDependency.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//   "GlobalSecondaryIndexes": [
	//     {
	//       "Projection": {
	//         "NonKeyAttributes": [ "myattribute" ]
	//         ...
	//       }
	//       ...
	//     },
	//     {
	//       "ProjectionType": "INCLUDE"
	//       ...
	//     },
	//   ]
	//   ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
	// cases, a snapshot can be taken of the resource prior to deletion
	// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
	// can be found in the following link:.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
	//
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Retrieves an array of resources this resource depends on.
	//
	// This assembles dependencies on resources across stacks (including nested stacks)
	// automatically.
	ObtainDependencies() *[]interface{}
	// Get a shallow copy of dependencies between this resource and other resources in the same stack.
	ObtainResourceDependencies() *[]awscdk.CfnResource
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	// Indicates that this resource no longer depends on another resource.
	//
	// This can be used for resources across stacks (including nested stacks)
	// and the dependency will automatically be removed from the relevant scope.
	RemoveDependency(target awscdk.CfnResource)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Replaces one dependency with another.
	ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::DLM::LifecyclePolicy`.

Specifies a lifecycle policy, which is used to automate operations on Amazon EBS resources.

The properties are required when you add a lifecycle policy and optional when you update a lifecycle policy.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnLifecyclePolicy := awscdk.Aws_dlm.NewCfnLifecyclePolicy(this, jsii.String("MyCfnLifecyclePolicy"), &CfnLifecyclePolicyProps{
	Description: jsii.String("description"),
	ExecutionRoleArn: jsii.String("executionRoleArn"),
	PolicyDetails: &PolicyDetailsProperty{
		Actions: []interface{}{
			&ActionProperty{
				CrossRegionCopy: []interface{}{
					&CrossRegionCopyActionProperty{
						EncryptionConfiguration: &EncryptionConfigurationProperty{
							Encrypted: jsii.Boolean(false),

							// the properties below are optional
							CmkArn: jsii.String("cmkArn"),
						},
						Target: jsii.String("target"),

						// the properties below are optional
						RetainRule: &CrossRegionCopyRetainRuleProperty{
							Interval: jsii.Number(123),
							IntervalUnit: jsii.String("intervalUnit"),
						},
					},
				},
				Name: jsii.String("name"),
			},
		},
		EventSource: &EventSourceProperty{
			Type: jsii.String("type"),

			// the properties below are optional
			Parameters: &EventParametersProperty{
				EventType: jsii.String("eventType"),
				SnapshotOwner: []*string{
					jsii.String("snapshotOwner"),
				},

				// the properties below are optional
				DescriptionRegex: jsii.String("descriptionRegex"),
			},
		},
		Parameters: &ParametersProperty{
			ExcludeBootVolume: jsii.Boolean(false),
			ExcludeDataVolumeTags: []interface{}{
				&CfnTag{
					Key: jsii.String("key"),
					Value: jsii.String("value"),
				},
			},
			NoReboot: jsii.Boolean(false),
		},
		PolicyType: jsii.String("policyType"),
		ResourceLocations: []*string{
			jsii.String("resourceLocations"),
		},
		ResourceTypes: []*string{
			jsii.String("resourceTypes"),
		},
		Schedules: []interface{}{
			&ScheduleProperty{
				ArchiveRule: &ArchiveRuleProperty{
					RetainRule: &ArchiveRetainRuleProperty{
						RetentionArchiveTier: &RetentionArchiveTierProperty{
							Count: jsii.Number(123),
							Interval: jsii.Number(123),
							IntervalUnit: jsii.String("intervalUnit"),
						},
					},
				},
				CopyTags: jsii.Boolean(false),
				CreateRule: &CreateRuleProperty{
					CronExpression: jsii.String("cronExpression"),
					Interval: jsii.Number(123),
					IntervalUnit: jsii.String("intervalUnit"),
					Location: jsii.String("location"),
					Times: []*string{
						jsii.String("times"),
					},
				},
				CrossRegionCopyRules: []interface{}{
					&CrossRegionCopyRuleProperty{
						Encrypted: jsii.Boolean(false),

						// the properties below are optional
						CmkArn: jsii.String("cmkArn"),
						CopyTags: jsii.Boolean(false),
						DeprecateRule: &CrossRegionCopyDeprecateRuleProperty{
							Interval: jsii.Number(123),
							IntervalUnit: jsii.String("intervalUnit"),
						},
						RetainRule: &CrossRegionCopyRetainRuleProperty{
							Interval: jsii.Number(123),
							IntervalUnit: jsii.String("intervalUnit"),
						},
						Target: jsii.String("target"),
						TargetRegion: jsii.String("targetRegion"),
					},
				},
				DeprecateRule: &DeprecateRuleProperty{
					Count: jsii.Number(123),
					Interval: jsii.Number(123),
					IntervalUnit: jsii.String("intervalUnit"),
				},
				FastRestoreRule: &FastRestoreRuleProperty{
					AvailabilityZones: []*string{
						jsii.String("availabilityZones"),
					},
					Count: jsii.Number(123),
					Interval: jsii.Number(123),
					IntervalUnit: jsii.String("intervalUnit"),
				},
				Name: jsii.String("name"),
				RetainRule: &RetainRuleProperty{
					Count: jsii.Number(123),
					Interval: jsii.Number(123),
					IntervalUnit: jsii.String("intervalUnit"),
				},
				ShareRules: []interface{}{
					&ShareRuleProperty{
						TargetAccounts: []*string{
							jsii.String("targetAccounts"),
						},
						UnshareInterval: jsii.Number(123),
						UnshareIntervalUnit: jsii.String("unshareIntervalUnit"),
					},
				},
				TagsToAdd: []interface{}{
					&CfnTag{
						Key: jsii.String("key"),
						Value: jsii.String("value"),
					},
				},
				VariableTags: []interface{}{
					&CfnTag{
						Key: jsii.String("key"),
						Value: jsii.String("value"),
					},
				},
			},
		},
		TargetTags: []interface{}{
			&CfnTag{
				Key: jsii.String("key"),
				Value: jsii.String("value"),
			},
		},
	},
	State: jsii.String("state"),
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
})

func NewCfnLifecyclePolicy 

func NewCfnLifecyclePolicy(scope constructs.Construct, id *string, props *CfnLifecyclePolicyProps) CfnLifecyclePolicy

Create a new `AWS::DLM::LifecyclePolicy`.

type CfnLifecyclePolicyProps 

type CfnLifecyclePolicyProps struct {
	// A description of the lifecycle policy.
	//
	// The characters ^[0-9A-Za-z _-]+$ are supported.
	Description *string `field:"optional" json:"description" yaml:"description"`
	// The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
	ExecutionRoleArn *string `field:"optional" json:"executionRoleArn" yaml:"executionRoleArn"`
	// The configuration details of the lifecycle policy.
	PolicyDetails interface{} `field:"optional" json:"policyDetails" yaml:"policyDetails"`
	// The activation state of the lifecycle policy.
	State *string `field:"optional" json:"state" yaml:"state"`
	// The tags to apply to the lifecycle policy during creation.
	Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}

Properties for defining a `CfnLifecyclePolicy`.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnLifecyclePolicyProps := &CfnLifecyclePolicyProps{
	Description: jsii.String("description"),
	ExecutionRoleArn: jsii.String("executionRoleArn"),
	PolicyDetails: &PolicyDetailsProperty{
		Actions: []interface{}{
			&ActionProperty{
				CrossRegionCopy: []interface{}{
					&CrossRegionCopyActionProperty{
						EncryptionConfiguration: &EncryptionConfigurationProperty{
							Encrypted: jsii.Boolean(false),

							// the properties below are optional
							CmkArn: jsii.String("cmkArn"),
						},
						Target: jsii.String("target"),

						// the properties below are optional
						RetainRule: &CrossRegionCopyRetainRuleProperty{
							Interval: jsii.Number(123),
							IntervalUnit: jsii.String("intervalUnit"),
						},
					},
				},
				Name: jsii.String("name"),
			},
		},
		EventSource: &EventSourceProperty{
			Type: jsii.String("type"),

			// the properties below are optional
			Parameters: &EventParametersProperty{
				EventType: jsii.String("eventType"),
				SnapshotOwner: []*string{
					jsii.String("snapshotOwner"),
				},

				// the properties below are optional
				DescriptionRegex: jsii.String("descriptionRegex"),
			},
		},
		Parameters: &ParametersProperty{
			ExcludeBootVolume: jsii.Boolean(false),
			ExcludeDataVolumeTags: []interface{}{
				&CfnTag{
					Key: jsii.String("key"),
					Value: jsii.String("value"),
				},
			},
			NoReboot: jsii.Boolean(false),
		},
		PolicyType: jsii.String("policyType"),
		ResourceLocations: []*string{
			jsii.String("resourceLocations"),
		},
		ResourceTypes: []*string{
			jsii.String("resourceTypes"),
		},
		Schedules: []interface{}{
			&ScheduleProperty{
				ArchiveRule: &ArchiveRuleProperty{
					RetainRule: &ArchiveRetainRuleProperty{
						RetentionArchiveTier: &RetentionArchiveTierProperty{
							Count: jsii.Number(123),
							Interval: jsii.Number(123),
							IntervalUnit: jsii.String("intervalUnit"),
						},
					},
				},
				CopyTags: jsii.Boolean(false),
				CreateRule: &CreateRuleProperty{
					CronExpression: jsii.String("cronExpression"),
					Interval: jsii.Number(123),
					IntervalUnit: jsii.String("intervalUnit"),
					Location: jsii.String("location"),
					Times: []*string{
						jsii.String("times"),
					},
				},
				CrossRegionCopyRules: []interface{}{
					&CrossRegionCopyRuleProperty{
						Encrypted: jsii.Boolean(false),

						// the properties below are optional
						CmkArn: jsii.String("cmkArn"),
						CopyTags: jsii.Boolean(false),
						DeprecateRule: &CrossRegionCopyDeprecateRuleProperty{
							Interval: jsii.Number(123),
							IntervalUnit: jsii.String("intervalUnit"),
						},
						RetainRule: &CrossRegionCopyRetainRuleProperty{
							Interval: jsii.Number(123),
							IntervalUnit: jsii.String("intervalUnit"),
						},
						Target: jsii.String("target"),
						TargetRegion: jsii.String("targetRegion"),
					},
				},
				DeprecateRule: &DeprecateRuleProperty{
					Count: jsii.Number(123),
					Interval: jsii.Number(123),
					IntervalUnit: jsii.String("intervalUnit"),
				},
				FastRestoreRule: &FastRestoreRuleProperty{
					AvailabilityZones: []*string{
						jsii.String("availabilityZones"),
					},
					Count: jsii.Number(123),
					Interval: jsii.Number(123),
					IntervalUnit: jsii.String("intervalUnit"),
				},
				Name: jsii.String("name"),
				RetainRule: &RetainRuleProperty{
					Count: jsii.Number(123),
					Interval: jsii.Number(123),
					IntervalUnit: jsii.String("intervalUnit"),
				},
				ShareRules: []interface{}{
					&ShareRuleProperty{
						TargetAccounts: []*string{
							jsii.String("targetAccounts"),
						},
						UnshareInterval: jsii.Number(123),
						UnshareIntervalUnit: jsii.String("unshareIntervalUnit"),
					},
				},
				TagsToAdd: []interface{}{
					&CfnTag{
						Key: jsii.String("key"),
						Value: jsii.String("value"),
					},
				},
				VariableTags: []interface{}{
					&CfnTag{
						Key: jsii.String("key"),
						Value: jsii.String("value"),
					},
				},
			},
		},
		TargetTags: []interface{}{
			&CfnTag{
				Key: jsii.String("key"),
				Value: jsii.String("value"),
			},
		},
	},
	State: jsii.String("state"),
	Tags: []cfnTag{
		&cfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

type CfnLifecyclePolicy_ActionProperty 

type CfnLifecyclePolicy_ActionProperty struct {
	// The rule for copying shared snapshots across Regions.
	CrossRegionCopy interface{} `field:"required" json:"crossRegionCopy" yaml:"crossRegionCopy"`
	// A descriptive name for the action.
	Name *string `field:"required" json:"name" yaml:"name"`
}

*[Event-based policies only]* Specifies an action for an event-based policy.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

actionProperty := &ActionProperty{
	CrossRegionCopy: []interface{}{
		&CrossRegionCopyActionProperty{
			EncryptionConfiguration: &EncryptionConfigurationProperty{
				Encrypted: jsii.Boolean(false),

				// the properties below are optional
				CmkArn: jsii.String("cmkArn"),
			},
			Target: jsii.String("target"),

			// the properties below are optional
			RetainRule: &CrossRegionCopyRetainRuleProperty{
				Interval: jsii.Number(123),
				IntervalUnit: jsii.String("intervalUnit"),
			},
		},
	},
	Name: jsii.String("name"),
}

type CfnLifecyclePolicy_ArchiveRetainRuleProperty added in v2.45.0 

type CfnLifecyclePolicy_ArchiveRetainRuleProperty struct {
	// `CfnLifecyclePolicy.ArchiveRetainRuleProperty.RetentionArchiveTier`.
	RetentionArchiveTier interface{} `field:"required" json:"retentionArchiveTier" yaml:"retentionArchiveTier"`
}

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

archiveRetainRuleProperty := &ArchiveRetainRuleProperty{
	RetentionArchiveTier: &RetentionArchiveTierProperty{
		Count: jsii.Number(123),
		Interval: jsii.Number(123),
		IntervalUnit: jsii.String("intervalUnit"),
	},
}

type CfnLifecyclePolicy_ArchiveRuleProperty added in v2.45.0 

type CfnLifecyclePolicy_ArchiveRuleProperty struct {
	// `CfnLifecyclePolicy.ArchiveRuleProperty.RetainRule`.
	RetainRule interface{} `field:"required" json:"retainRule" yaml:"retainRule"`
}

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

archiveRuleProperty := &ArchiveRuleProperty{
	RetainRule: &ArchiveRetainRuleProperty{
		RetentionArchiveTier: &RetentionArchiveTierProperty{
			Count: jsii.Number(123),
			Interval: jsii.Number(123),
			IntervalUnit: jsii.String("intervalUnit"),
		},
	},
}

type CfnLifecyclePolicy_CreateRuleProperty 

type CfnLifecyclePolicy_CreateRuleProperty struct {
	// The schedule, as a Cron expression.
	//
	// The schedule interval must be between 1 hour and 1 year. For more information, see [Cron expressions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions) in the *Amazon CloudWatch User Guide* .
	CronExpression *string `field:"optional" json:"cronExpression" yaml:"cronExpression"`
	// The interval between snapshots.
	//
	// The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.
	Interval *float64 `field:"optional" json:"interval" yaml:"interval"`
	// The interval unit.
	IntervalUnit *string `field:"optional" json:"intervalUnit" yaml:"intervalUnit"`
	// *[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 AWS 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.
	Location *string `field:"optional" json:"location" yaml:"location"`
	// The time, in UTC, to start the operation. The supported format is hh:mm.
	//
	// The operation occurs within a one-hour window following the specified time. If you do not specify a time, Amazon Data Lifecycle Manager selects a time within the next 24 hours.
	Times *[]*string `field:"optional" json:"times" yaml:"times"`
}

*[Snapshot and AMI policies only]* Specifies when the policy should create snapshots or AMIs.

> - You must specify either *CronExpression* , or *Interval* , *IntervalUnit* , and *Times* . > - If you need to specify an `ArchiveRule` for the schedule, then you must specify a creation frequency of at least 28 days.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

createRuleProperty := &CreateRuleProperty{
	CronExpression: jsii.String("cronExpression"),
	Interval: jsii.Number(123),
	IntervalUnit: jsii.String("intervalUnit"),
	Location: jsii.String("location"),
	Times: []*string{
		jsii.String("times"),
	},
}

type CfnLifecyclePolicy_CrossRegionCopyActionProperty 

type CfnLifecyclePolicy_CrossRegionCopyActionProperty struct {
	// The encryption settings for the copied snapshot.
	EncryptionConfiguration interface{} `field:"required" json:"encryptionConfiguration" yaml:"encryptionConfiguration"`
	// The target Region.
	Target *string `field:"required" json:"target" yaml:"target"`
	// 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.
	RetainRule interface{} `field:"optional" json:"retainRule" yaml:"retainRule"`
}

*[Event-based policies only]* Specifies a cross-Region copy action for event-based policies.

> To specify a cross-Region copy rule for snapshot and AMI policies, use `CrossRegionCopyRule` .

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

crossRegionCopyActionProperty := &CrossRegionCopyActionProperty{
	EncryptionConfiguration: &EncryptionConfigurationProperty{
		Encrypted: jsii.Boolean(false),

		// the properties below are optional
		CmkArn: jsii.String("cmkArn"),
	},
	Target: jsii.String("target"),

	// the properties below are optional
	RetainRule: &CrossRegionCopyRetainRuleProperty{
		Interval: jsii.Number(123),
		IntervalUnit: jsii.String("intervalUnit"),
	},
}

type CfnLifecyclePolicy_CrossRegionCopyDeprecateRuleProperty 

type CfnLifecyclePolicy_CrossRegionCopyDeprecateRuleProperty struct {
	// `CfnLifecyclePolicy.CrossRegionCopyDeprecateRuleProperty.Interval`.
	Interval *float64 `field:"required" json:"interval" yaml:"interval"`
	// `CfnLifecyclePolicy.CrossRegionCopyDeprecateRuleProperty.IntervalUnit`.
	IntervalUnit *string `field:"required" json:"intervalUnit" yaml:"intervalUnit"`
}

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

crossRegionCopyDeprecateRuleProperty := &CrossRegionCopyDeprecateRuleProperty{
	Interval: jsii.Number(123),
	IntervalUnit: jsii.String("intervalUnit"),
}

type CfnLifecyclePolicy_CrossRegionCopyRetainRuleProperty 

type CfnLifecyclePolicy_CrossRegionCopyRetainRuleProperty struct {
	// 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.
	Interval *float64 `field:"required" json:"interval" yaml:"interval"`
	// 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` .
	IntervalUnit *string `field:"required" json:"intervalUnit" yaml:"intervalUnit"`
}

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.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

crossRegionCopyRetainRuleProperty := &CrossRegionCopyRetainRuleProperty{
	Interval: jsii.Number(123),
	IntervalUnit: jsii.String("intervalUnit"),
}

type CfnLifecyclePolicy_CrossRegionCopyRuleProperty 

type CfnLifecyclePolicy_CrossRegionCopyRuleProperty struct {
	// 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.
	Encrypted interface{} `field:"required" json:"encrypted" yaml:"encrypted"`
	// The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption.
	//
	// If this parameter is not specified, the default KMS key for the account is used.
	CmkArn *string `field:"optional" json:"cmkArn" yaml:"cmkArn"`
	// Indicates whether to copy all user-defined tags from the source snapshot or AMI to the cross-Region copy.
	CopyTags interface{} `field:"optional" json:"copyTags" yaml:"copyTags"`
	// `CfnLifecyclePolicy.CrossRegionCopyRuleProperty.DeprecateRule`.
	DeprecateRule interface{} `field:"optional" json:"deprecateRule" yaml:"deprecateRule"`
	// The retention rule that indicates how long the cross-Region snapshot or AMI copies are to be retained in the destination Region.
	RetainRule interface{} `field:"optional" json:"retainRule" yaml:"retainRule"`
	// The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies.
	//
	// Use this parameter instead of *TargetRegion* . Do not specify both.
	Target *string `field:"optional" json:"target" yaml:"target"`
	// > Avoid using this parameter when creating new policies.
	//
	// Instead, use *Target* to specify a target Region or a target Outpost for snapshot copies.
	// >
	// > For policies created before the *Target* parameter was introduced, this parameter indicates the target Region for snapshot copies.
	TargetRegion *string `field:"optional" json:"targetRegion" yaml:"targetRegion"`
}

*[Snapshot and AMI policies only]* Specifies a cross-Region copy rule for snapshot and AMI policies.

> To specify a cross-Region copy action for event-based polices, use `CrossRegionCopyAction` .

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

crossRegionCopyRuleProperty := &CrossRegionCopyRuleProperty{
	Encrypted: jsii.Boolean(false),

	// the properties below are optional
	CmkArn: jsii.String("cmkArn"),
	CopyTags: jsii.Boolean(false),
	DeprecateRule: &CrossRegionCopyDeprecateRuleProperty{
		Interval: jsii.Number(123),
		IntervalUnit: jsii.String("intervalUnit"),
	},
	RetainRule: &CrossRegionCopyRetainRuleProperty{
		Interval: jsii.Number(123),
		IntervalUnit: jsii.String("intervalUnit"),
	},
	Target: jsii.String("target"),
	TargetRegion: jsii.String("targetRegion"),
}

type CfnLifecyclePolicy_DeprecateRuleProperty 

type CfnLifecyclePolicy_DeprecateRuleProperty struct {
	// `CfnLifecyclePolicy.DeprecateRuleProperty.Count`.
	Count *float64 `field:"optional" json:"count" yaml:"count"`
	// `CfnLifecyclePolicy.DeprecateRuleProperty.Interval`.
	Interval *float64 `field:"optional" json:"interval" yaml:"interval"`
	// `CfnLifecyclePolicy.DeprecateRuleProperty.IntervalUnit`.
	IntervalUnit *string `field:"optional" json:"intervalUnit" yaml:"intervalUnit"`
}

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

deprecateRuleProperty := &DeprecateRuleProperty{
	Count: jsii.Number(123),
	Interval: jsii.Number(123),
	IntervalUnit: jsii.String("intervalUnit"),
}

type CfnLifecyclePolicy_EncryptionConfigurationProperty 

type CfnLifecyclePolicy_EncryptionConfigurationProperty struct {
	// 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.
	Encrypted interface{} `field:"required" json:"encrypted" yaml:"encrypted"`
	// The Amazon Resource Name (ARN) of the AWS KMS key to use for EBS encryption.
	//
	// If this parameter is not specified, the default KMS key for the account is used.
	CmkArn *string `field:"optional" json:"cmkArn" yaml:"cmkArn"`
}

*[Event-based policies only]* Specifies the encryption settings for cross-Region snapshot copies created by event-based policies.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

encryptionConfigurationProperty := &EncryptionConfigurationProperty{
	Encrypted: jsii.Boolean(false),

	// the properties below are optional
	CmkArn: jsii.String("cmkArn"),
}

type CfnLifecyclePolicy_EventParametersProperty 

type CfnLifecyclePolicy_EventParametersProperty struct {
	// The type of event.
	//
	// Currently, only snapshot sharing events are supported.
	EventType *string `field:"required" json:"eventType" yaml:"eventType"`
	// The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account.
	//
	// The policy only runs if one of the specified AWS accounts shares a snapshot with your account.
	SnapshotOwner *[]*string `field:"required" json:"snapshotOwner" yaml:"snapshotOwner"`
	// 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.
	DescriptionRegex *string `field:"optional" json:"descriptionRegex" yaml:"descriptionRegex"`
}

*[Event-based policies only]* Specifies an event that activates an event-based policy.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

eventParametersProperty := &EventParametersProperty{
	EventType: jsii.String("eventType"),
	SnapshotOwner: []*string{
		jsii.String("snapshotOwner"),
	},

	// the properties below are optional
	DescriptionRegex: jsii.String("descriptionRegex"),
}

type CfnLifecyclePolicy_EventSourceProperty 

type CfnLifecyclePolicy_EventSourceProperty struct {
	// The source of the event.
	//
	// Currently only managed CloudWatch Events rules are supported.
	Type *string `field:"required" json:"type" yaml:"type"`
	// Information about the event.
	Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"`
}

*[Event-based policies only]* Specifies an event that activates an event-based policy.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

eventSourceProperty := &EventSourceProperty{
	Type: jsii.String("type"),

	// the properties below are optional
	Parameters: &EventParametersProperty{
		EventType: jsii.String("eventType"),
		SnapshotOwner: []*string{
			jsii.String("snapshotOwner"),
		},

		// the properties below are optional
		DescriptionRegex: jsii.String("descriptionRegex"),
	},
}

type CfnLifecyclePolicy_FastRestoreRuleProperty 

type CfnLifecyclePolicy_FastRestoreRuleProperty struct {
	// The Availability Zones in which to enable fast snapshot restore.
	AvailabilityZones *[]*string `field:"optional" json:"availabilityZones" yaml:"availabilityZones"`
	// The number of snapshots to be enabled with fast snapshot restore.
	Count *float64 `field:"optional" json:"count" yaml:"count"`
	// 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.
	Interval *float64 `field:"optional" json:"interval" yaml:"interval"`
	// The unit of time for enabling fast snapshot restore.
	IntervalUnit *string `field:"optional" json:"intervalUnit" yaml:"intervalUnit"`
}

*[Snapshot policies only]* Specifies a rule for enabling fast snapshot restore for snapshots created by snapshot policies.

You can enable fast snapshot restore based on either a count or a time interval.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

fastRestoreRuleProperty := &FastRestoreRuleProperty{
	AvailabilityZones: []*string{
		jsii.String("availabilityZones"),
	},
	Count: jsii.Number(123),
	Interval: jsii.Number(123),
	IntervalUnit: jsii.String("intervalUnit"),
}

type CfnLifecyclePolicy_ParametersProperty 

type CfnLifecyclePolicy_ParametersProperty struct {
	// *[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.
	ExcludeBootVolume interface{} `field:"optional" json:"excludeBootVolume" yaml:"excludeBootVolume"`
	// `CfnLifecyclePolicy.ParametersProperty.ExcludeDataVolumeTags`.
	ExcludeDataVolumeTags interface{} `field:"optional" json:"excludeDataVolumeTags" yaml:"excludeDataVolumeTags"`
	// *[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).
	NoReboot interface{} `field:"optional" json:"noReboot" yaml:"noReboot"`
}

*[Snapshot and AMI policies only]* Specifies optional parameters for snapshot and AMI policies.

The set of valid parameters depends on the combination of policy type and target resource type.

If you choose to exclude boot volumes and you specify tags that consequently exclude all of the additional data volumes attached to an instance, then Amazon Data Lifecycle Manager will not create any snapshots for the affected instance, and it will emit a `SnapshotsCreateFailed` Amazon CloudWatch metric. For more information, see [Monitor your policies using Amazon CloudWatch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitor-dlm-cw-metrics.html) .

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

parametersProperty := &ParametersProperty{
	ExcludeBootVolume: jsii.Boolean(false),
	ExcludeDataVolumeTags: []interface{}{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	NoReboot: jsii.Boolean(false),
}

type CfnLifecyclePolicy_PolicyDetailsProperty 

type CfnLifecyclePolicy_PolicyDetailsProperty struct {
	// *[Event-based policies only]* The actions to be performed when the event-based policy is activated.
	//
	// You can specify only one action per policy.
	Actions interface{} `field:"optional" json:"actions" yaml:"actions"`
	// *[Event-based policies only]* The event that activates the event-based policy.
	EventSource interface{} `field:"optional" json:"eventSource" yaml:"eventSource"`
	// *[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.
	Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"`
	// *[All policy types]* 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 .
	//
	// The default is `EBS_SNAPSHOT_MANAGEMENT` .
	PolicyType *string `field:"optional" json:"policyType" yaml:"policyType"`
	// *[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.
	ResourceLocations *[]*string `field:"optional" json:"resourceLocations" yaml:"resourceLocations"`
	// *[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.
	ResourceTypes *[]*string `field:"optional" json:"resourceTypes" yaml:"resourceTypes"`
	// *[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.
	Schedules interface{} `field:"optional" json:"schedules" yaml:"schedules"`
	// *[Snapshot and AMI policies only]* The single tag that identifies targeted resources for this policy.
	TargetTags interface{} `field:"optional" json:"targetTags" yaml:"targetTags"`
}

*[All policy types]* Specifies the configuration of a lifecycle policy.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

policyDetailsProperty := &PolicyDetailsProperty{
	Actions: []interface{}{
		&ActionProperty{
			CrossRegionCopy: []interface{}{
				&CrossRegionCopyActionProperty{
					EncryptionConfiguration: &EncryptionConfigurationProperty{
						Encrypted: jsii.Boolean(false),

						// the properties below are optional
						CmkArn: jsii.String("cmkArn"),
					},
					Target: jsii.String("target"),

					// the properties below are optional
					RetainRule: &CrossRegionCopyRetainRuleProperty{
						Interval: jsii.Number(123),
						IntervalUnit: jsii.String("intervalUnit"),
					},
				},
			},
			Name: jsii.String("name"),
		},
	},
	EventSource: &EventSourceProperty{
		Type: jsii.String("type"),

		// the properties below are optional
		Parameters: &EventParametersProperty{
			EventType: jsii.String("eventType"),
			SnapshotOwner: []*string{
				jsii.String("snapshotOwner"),
			},

			// the properties below are optional
			DescriptionRegex: jsii.String("descriptionRegex"),
		},
	},
	Parameters: &ParametersProperty{
		ExcludeBootVolume: jsii.Boolean(false),
		ExcludeDataVolumeTags: []interface{}{
			&CfnTag{
				Key: jsii.String("key"),
				Value: jsii.String("value"),
			},
		},
		NoReboot: jsii.Boolean(false),
	},
	PolicyType: jsii.String("policyType"),
	ResourceLocations: []*string{
		jsii.String("resourceLocations"),
	},
	ResourceTypes: []*string{
		jsii.String("resourceTypes"),
	},
	Schedules: []interface{}{
		&ScheduleProperty{
			ArchiveRule: &ArchiveRuleProperty{
				RetainRule: &ArchiveRetainRuleProperty{
					RetentionArchiveTier: &RetentionArchiveTierProperty{
						Count: jsii.Number(123),
						Interval: jsii.Number(123),
						IntervalUnit: jsii.String("intervalUnit"),
					},
				},
			},
			CopyTags: jsii.Boolean(false),
			CreateRule: &CreateRuleProperty{
				CronExpression: jsii.String("cronExpression"),
				Interval: jsii.Number(123),
				IntervalUnit: jsii.String("intervalUnit"),
				Location: jsii.String("location"),
				Times: []*string{
					jsii.String("times"),
				},
			},
			CrossRegionCopyRules: []interface{}{
				&CrossRegionCopyRuleProperty{
					Encrypted: jsii.Boolean(false),

					// the properties below are optional
					CmkArn: jsii.String("cmkArn"),
					CopyTags: jsii.Boolean(false),
					DeprecateRule: &CrossRegionCopyDeprecateRuleProperty{
						Interval: jsii.Number(123),
						IntervalUnit: jsii.String("intervalUnit"),
					},
					RetainRule: &CrossRegionCopyRetainRuleProperty{
						Interval: jsii.Number(123),
						IntervalUnit: jsii.String("intervalUnit"),
					},
					Target: jsii.String("target"),
					TargetRegion: jsii.String("targetRegion"),
				},
			},
			DeprecateRule: &DeprecateRuleProperty{
				Count: jsii.Number(123),
				Interval: jsii.Number(123),
				IntervalUnit: jsii.String("intervalUnit"),
			},
			FastRestoreRule: &FastRestoreRuleProperty{
				AvailabilityZones: []*string{
					jsii.String("availabilityZones"),
				},
				Count: jsii.Number(123),
				Interval: jsii.Number(123),
				IntervalUnit: jsii.String("intervalUnit"),
			},
			Name: jsii.String("name"),
			RetainRule: &RetainRuleProperty{
				Count: jsii.Number(123),
				Interval: jsii.Number(123),
				IntervalUnit: jsii.String("intervalUnit"),
			},
			ShareRules: []interface{}{
				&ShareRuleProperty{
					TargetAccounts: []*string{
						jsii.String("targetAccounts"),
					},
					UnshareInterval: jsii.Number(123),
					UnshareIntervalUnit: jsii.String("unshareIntervalUnit"),
				},
			},
			TagsToAdd: []interface{}{
				&CfnTag{
					Key: jsii.String("key"),
					Value: jsii.String("value"),
				},
			},
			VariableTags: []interface{}{
				&CfnTag{
					Key: jsii.String("key"),
					Value: jsii.String("value"),
				},
			},
		},
	},
	TargetTags: []interface{}{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

type CfnLifecyclePolicy_RetainRuleProperty 

type CfnLifecyclePolicy_RetainRuleProperty struct {
	// 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` .
	Count *float64 `field:"optional" json:"count" yaml:"count"`
	// The amount of time to retain each snapshot.
	//
	// The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days.
	Interval *float64 `field:"optional" json:"interval" yaml:"interval"`
	// 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` .
	IntervalUnit *string `field:"optional" json:"intervalUnit" yaml:"intervalUnit"`
}

*[Snapshot and AMI policies only]* Specifies a retention rule for snapshots created by snapshot policies, or for AMIs created by AMI policies.

> For snapshot policies that have an `ArchiveRule` , this retention rule applies to standard tier retention. When the retention threshold is met, snapshots are moved from the standard to the archive tier. > > For snapshot policies that do not have an *ArchiveRule* , snapshots are permanently deleted when this retention threshold is met.

You can retain snapshots based on either a count or a time interval.

- *Count-based retention*

You must specify *Count* . If you specify an `ArchiveRule` for the schedule, then you can specify a retention count of `0` to archive snapshots immediately after creation. If you specify a `FastRestoreRule` , `ShareRule` , or a `CrossRegionCopyRule` , then you must specify a retention count of `1` or more. - *Age-based retention*

You must specify *Interval* and *IntervalUnit* . If you specify an `ArchiveRule` for the schedule, then you can specify a retention interval of `0` days to archive snapshots immediately after creation. If you specify a `FastRestoreRule` , `ShareRule` , or a `CrossRegionCopyRule` , then you must specify a retention interval of `1` day or more.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

retainRuleProperty := &RetainRuleProperty{
	Count: jsii.Number(123),
	Interval: jsii.Number(123),
	IntervalUnit: jsii.String("intervalUnit"),
}

type CfnLifecyclePolicy_RetentionArchiveTierProperty added in v2.45.0 

type CfnLifecyclePolicy_RetentionArchiveTierProperty struct {
	// `CfnLifecyclePolicy.RetentionArchiveTierProperty.Count`.
	Count *float64 `field:"optional" json:"count" yaml:"count"`
	// `CfnLifecyclePolicy.RetentionArchiveTierProperty.Interval`.
	Interval *float64 `field:"optional" json:"interval" yaml:"interval"`
	// `CfnLifecyclePolicy.RetentionArchiveTierProperty.IntervalUnit`.
	IntervalUnit *string `field:"optional" json:"intervalUnit" yaml:"intervalUnit"`
}

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

retentionArchiveTierProperty := &RetentionArchiveTierProperty{
	Count: jsii.Number(123),
	Interval: jsii.Number(123),
	IntervalUnit: jsii.String("intervalUnit"),
}

type CfnLifecyclePolicy_ScheduleProperty 

type CfnLifecyclePolicy_ScheduleProperty struct {
	// `CfnLifecyclePolicy.ScheduleProperty.ArchiveRule`.
	ArchiveRule interface{} `field:"optional" json:"archiveRule" yaml:"archiveRule"`
	// Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
	CopyTags interface{} `field:"optional" json:"copyTags" yaml:"copyTags"`
	// The creation rule.
	CreateRule interface{} `field:"optional" json:"createRule" yaml:"createRule"`
	// Specifies a rule for copying snapshots or AMIs across regions.
	//
	// > You can't specify cross-Region copy rules for policies that create snapshots on an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.
	CrossRegionCopyRules interface{} `field:"optional" json:"crossRegionCopyRules" yaml:"crossRegionCopyRules"`
	// `CfnLifecyclePolicy.ScheduleProperty.DeprecateRule`.
	DeprecateRule interface{} `field:"optional" json:"deprecateRule" yaml:"deprecateRule"`
	// *[Snapshot policies only]* The rule for enabling fast snapshot restore.
	FastRestoreRule interface{} `field:"optional" json:"fastRestoreRule" yaml:"fastRestoreRule"`
	// The name of the schedule.
	Name *string `field:"optional" json:"name" yaml:"name"`
	// The retention rule for snapshots or AMIs created by the policy.
	RetainRule interface{} `field:"optional" json:"retainRule" yaml:"retainRule"`
	// *[Snapshot policies only]* The rule for sharing snapshots with other AWS accounts .
	ShareRules interface{} `field:"optional" json:"shareRules" yaml:"shareRules"`
	// The tags to apply to policy-created resources.
	//
	// These user-defined tags are in addition to the AWS -added lifecycle tags.
	TagsToAdd interface{} `field:"optional" json:"tagsToAdd" yaml:"tagsToAdd"`
	// *[AMI policies and snapshot policies that target instances only]* A collection of key/value pairs with values determined dynamically when the policy is executed.
	//
	// Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: `$(instance-id)` or `$(timestamp)` . Variable tags are only valid for EBS Snapshot Management – Instance policies.
	VariableTags interface{} `field:"optional" json:"variableTags" yaml:"variableTags"`
}

*[Snapshot and AMI policies only]* Specifies a schedule for a snapshot or AMI lifecycle policy.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

scheduleProperty := &ScheduleProperty{
	ArchiveRule: &ArchiveRuleProperty{
		RetainRule: &ArchiveRetainRuleProperty{
			RetentionArchiveTier: &RetentionArchiveTierProperty{
				Count: jsii.Number(123),
				Interval: jsii.Number(123),
				IntervalUnit: jsii.String("intervalUnit"),
			},
		},
	},
	CopyTags: jsii.Boolean(false),
	CreateRule: &CreateRuleProperty{
		CronExpression: jsii.String("cronExpression"),
		Interval: jsii.Number(123),
		IntervalUnit: jsii.String("intervalUnit"),
		Location: jsii.String("location"),
		Times: []*string{
			jsii.String("times"),
		},
	},
	CrossRegionCopyRules: []interface{}{
		&CrossRegionCopyRuleProperty{
			Encrypted: jsii.Boolean(false),

			// the properties below are optional
			CmkArn: jsii.String("cmkArn"),
			CopyTags: jsii.Boolean(false),
			DeprecateRule: &CrossRegionCopyDeprecateRuleProperty{
				Interval: jsii.Number(123),
				IntervalUnit: jsii.String("intervalUnit"),
			},
			RetainRule: &CrossRegionCopyRetainRuleProperty{
				Interval: jsii.Number(123),
				IntervalUnit: jsii.String("intervalUnit"),
			},
			Target: jsii.String("target"),
			TargetRegion: jsii.String("targetRegion"),
		},
	},
	DeprecateRule: &DeprecateRuleProperty{
		Count: jsii.Number(123),
		Interval: jsii.Number(123),
		IntervalUnit: jsii.String("intervalUnit"),
	},
	FastRestoreRule: &FastRestoreRuleProperty{
		AvailabilityZones: []*string{
			jsii.String("availabilityZones"),
		},
		Count: jsii.Number(123),
		Interval: jsii.Number(123),
		IntervalUnit: jsii.String("intervalUnit"),
	},
	Name: jsii.String("name"),
	RetainRule: &RetainRuleProperty{
		Count: jsii.Number(123),
		Interval: jsii.Number(123),
		IntervalUnit: jsii.String("intervalUnit"),
	},
	ShareRules: []interface{}{
		&ShareRuleProperty{
			TargetAccounts: []*string{
				jsii.String("targetAccounts"),
			},
			UnshareInterval: jsii.Number(123),
			UnshareIntervalUnit: jsii.String("unshareIntervalUnit"),
		},
	},
	TagsToAdd: []interface{}{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	VariableTags: []interface{}{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

type CfnLifecyclePolicy_ShareRuleProperty 

type CfnLifecyclePolicy_ShareRuleProperty struct {
	// The IDs of the AWS accounts with which to share the snapshots.
	TargetAccounts *[]*string `field:"optional" json:"targetAccounts" yaml:"targetAccounts"`
	// The period after which snapshots that are shared with other AWS accounts are automatically unshared.
	UnshareInterval *float64 `field:"optional" json:"unshareInterval" yaml:"unshareInterval"`
	// The unit of time for the automatic unsharing interval.
	UnshareIntervalUnit *string `field:"optional" json:"unshareIntervalUnit" yaml:"unshareIntervalUnit"`
}

*[Snapshot policies only]* Specifies a rule for sharing snapshots across AWS accounts .

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

shareRuleProperty := &ShareRuleProperty{
	TargetAccounts: []*string{
		jsii.String("targetAccounts"),
	},
	UnshareInterval: jsii.Number(123),
	UnshareIntervalUnit: jsii.String("unshareIntervalUnit"),
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.