Experimental
@aws-cdk/aws-imagebuilder-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
LifecyclePolicy L2 construct
Represents an EC2 Image Builder Lifecycle Policy.
Example
ts
const disabledPolicy = new imagebuilder.LifecyclePolicy(this, 'DisabledPolicy', {
lifecyclePolicyName: 'my-disabled-policy',
description: 'A lifecycle policy that is temporarily disabled',
status: imagebuilder.LifecyclePolicyStatus.DISABLED,
resourceType: imagebuilder.LifecyclePolicyResourceType.AMI_IMAGE,
details: [
{
action: { type: imagebuilder.LifecyclePolicyActionType.DELETE },
filter: { ageFilter: { age: Duration.days(30) } }
}
],
resourceSelection: {
tags: { Environment: 'testing' }
},
tags: {
Owner: 'DevOps',
CostCenter: 'Engineering'
}
});
python
disabled_policy = imagebuilder.LifecyclePolicy(self, "DisabledPolicy",
lifecycle_policy_name="my-disabled-policy",
description="A lifecycle policy that is temporarily disabled",
status=imagebuilder.LifecyclePolicyStatus.DISABLED,
resource_type=imagebuilder.LifecyclePolicyResourceType.AMI_IMAGE,
details=[imagebuilder.LifecyclePolicyDetail(
action=imagebuilder.LifecyclePolicyAction(type=imagebuilder.LifecyclePolicyActionType.DELETE),
filter=imagebuilder.LifecyclePolicyFilter(age_filter=imagebuilder.LifecyclePolicyAgeFilter(age=Duration.days(30)))
)
],
resource_selection=imagebuilder.LifecyclePolicyResourceSelection(
tags={"Environment": "testing"}
),
tags={
"Owner": "DevOps",
"CostCenter": "Engineering"
}
)
java
LifecyclePolicy disabledPolicy = LifecyclePolicy.Builder.create(this, "DisabledPolicy")
.lifecyclePolicyName("my-disabled-policy")
.description("A lifecycle policy that is temporarily disabled")
.status(LifecyclePolicyStatus.DISABLED)
.resourceType(LifecyclePolicyResourceType.AMI_IMAGE)
.details(List.of(LifecyclePolicyDetail.builder()
.action(LifecyclePolicyAction.builder().type(LifecyclePolicyActionType.DELETE).build())
.filter(LifecyclePolicyFilter.builder().ageFilter(LifecyclePolicyAgeFilter.builder().age(Duration.days(30)).build()).build())
.build()))
.resourceSelection(LifecyclePolicyResourceSelection.builder()
.tags(Map.of("Environment", "testing"))
.build())
.tags(Map.of(
"Owner", "DevOps",
"CostCenter", "Engineering"))
.build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.ImageBuilder.Alpha
var disabledPolicy = new LifecyclePolicy(this, "DisabledPolicy", new LifecyclePolicyProps {
LifecyclePolicyName = "my-disabled-policy",
Description = "A lifecycle policy that is temporarily disabled",
Status = LifecyclePolicyStatus.DISABLED,
ResourceType = LifecyclePolicyResourceType.AMI_IMAGE,
Details = new [] { new LifecyclePolicyDetail {
Action = new LifecyclePolicyAction { Type = LifecyclePolicyActionType.DELETE },
Filter = new LifecyclePolicyFilter { AgeFilter = new LifecyclePolicyAgeFilter { Age = Duration.Days(30) } }
} },
ResourceSelection = new LifecyclePolicyResourceSelection {
Tags = new Dictionary<string, string> { { "Environment", "testing" } }
},
Tags = new Dictionary<string, string> {
{ "Owner", "DevOps" },
{ "CostCenter", "Engineering" }
}
});
go
// Install: go get github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2
disabledPolicy := imagebuilder.NewLifecyclePolicy(this, jsii.String("DisabledPolicy"), &LifecyclePolicyProps{
LifecyclePolicyName: jsii.String("my-disabled-policy"),
Description: jsii.String("A lifecycle policy that is temporarily disabled"),
Status: imagebuilder.LifecyclePolicyStatus_DISABLED,
ResourceType: imagebuilder.LifecyclePolicyResourceType_AMI_IMAGE,
Details: []LifecyclePolicyDetail{
&LifecyclePolicyDetail{
Action: &LifecyclePolicyAction{
Type: imagebuilder.LifecyclePolicyActionType_DELETE,
},
Filter: &LifecyclePolicyFilter{
AgeFilter: &LifecyclePolicyAgeFilter{
Age: awscdk.Duration_Days(jsii.Number(30)),
},
},
},
},
ResourceSelection: &LifecyclePolicyResourceSelection{
Tags: map[string]*string{
"Environment": jsii.String("testing"),
},
},
Tags: map[string]*string{
"Owner": jsii.String("DevOps"),
"CostCenter": jsii.String("Engineering"),
},
})
Initializer
ts
new LifecyclePolicy(scope: Construct, id: string, props: LifecyclePolicyProps)
python
LifecyclePolicy(scope: Construct, id: str, props: LifecyclePolicyProps)
java
new LifecyclePolicy(Construct scope, String id, LifecyclePolicyProps props)
csharp
new LifecyclePolicy(Construct scope, string id, LifecyclePolicyProps props)
go
NewLifecyclePolicy(Scope Construct, Id *string, Props LifecyclePolicyProps)
Construct Props
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string= None#The description of the lifecycle policy.
detailsLifecyclePolicyDetail[]detailstyping.List[LifecyclePolicyDetail]detailsList<LifecyclePolicyDetail>DetailsLifecyclePolicyDetail[]Details*[]LifecyclePolicyDetailrequired#Configuration details for the lifecycle policy rules.
executionRoleoptionalIRoleexecution_roleoptionalIRoleexecutionRoleoptionalIRoleExecutionRoleoptionalIRoleExecutionRoleoptionalIRole#The execution role that grants Image Builder access to run lifecycle actions.
Default: an execution role will be generated
By default, an execution role will be created with the minimal permissions needed to execute the lifecycle policy actions.
lifecyclePolicyNameoptionalstringlifecycle_policy_nameoptionalstrlifecyclePolicyNameoptionalStringLifecyclePolicyNameoptionalstringLifecyclePolicyNameoptional*string#The name of the lifecycle policy.
Default: a name is generated
resourceSelectionLifecyclePolicyResourceSelectionresource_selectionLifecyclePolicyResourceSelectionresourceSelectionLifecyclePolicyResourceSelectionResourceSelectionLifecyclePolicyResourceSelectionResourceSelectionLifecyclePolicyResourceSelectionrequired#Selection criteria for the resources that the lifecycle policy applies to.
resourceTypeLifecyclePolicyResourceTyperesource_typeLifecyclePolicyResourceTyperesourceTypeLifecyclePolicyResourceTypeResourceTypeLifecyclePolicyResourceTypeResourceTypeLifecyclePolicyResourceTyperequired#The type of Image Builder resource that the lifecycle policy applies to.
statusoptionalLifecyclePolicyStatusstatusoptionalLifecyclePolicyStatusstatusoptionalLifecyclePolicyStatusStatusoptionalLifecyclePolicyStatusStatusoptionalLifecyclePolicyStatus= LifecyclePolicyStatus.ENABLED#The status of the lifecycle policy.
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string= none#The tags to apply to the lifecycle policy.
Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#The environment this resource belongs to.
notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
executionRoleIRoleexecution_roleIRoleexecutionRoleIRoleExecutionRoleIRoleExecutionRoleIRolerequired#The execution role used for lifecycle policy executions.
lifecyclePolicyArnstringlifecycle_policy_arnstrlifecyclePolicyArnStringLifecyclePolicyArnstringLifecyclePolicyArn*stringrequired#The ARN of the lifecycle policy.
lifecyclePolicyNamestringlifecycle_policy_namestrlifecyclePolicyNameStringLifecyclePolicyNamestringLifecyclePolicyName*stringrequired#The name of the lifecycle policy.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Uniquely identifies this class.
Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Override the cross-stack reference strength for this resource.
notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
notes
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).
fromLifecyclePolicyArn(scope: Construct, id: string, lifecyclePolicyArn: string): ILifecyclePolicy@staticmethod def from_lifecycle_policy_arn(scope: Construct, id: str, lifecycle_policy_arn: str) -> ILifecyclePolicypublic static ILifecyclePolicy fromLifecyclePolicyArn(Construct scope, String id, String lifecyclePolicyArn)public static ILifecyclePolicy FromLifecyclePolicyArn(Construct scope, string id, string lifecyclePolicyArn)func FromLifecyclePolicyArn(Scope Construct, Id *string, LifecyclePolicyArn *string) ILifecyclePolicystatic#Import an existing lifecycle policy given its ARN.
fromLifecyclePolicyName(scope: Construct, id: string, lifecyclePolicyName: string): ILifecyclePolicy@staticmethod def from_lifecycle_policy_name(scope: Construct, id: str, lifecycle_policy_name: str) -> ILifecyclePolicypublic static ILifecyclePolicy fromLifecyclePolicyName(Construct scope, String id, String lifecyclePolicyName)public static ILifecyclePolicy FromLifecyclePolicyName(Construct scope, string id, string lifecyclePolicyName)func FromLifecyclePolicyName(Scope Construct, Id *string, LifecyclePolicyName *string) ILifecyclePolicystatic#Import an existing lifecycle policy given its name.
If the name is a token representing a dynamic CloudFormation expression, you must ensure all alphabetic characters in the expression are already lowercased
grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#[disable-awslint:no-grants].
grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#[disable-awslint:no-grants].
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
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.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isLifecyclePolicy(x: any): boolean@staticmethod def is_lifecycle_policy(x: Any) -> boolpublic static Boolean isLifecyclePolicy(Object x)public static bool IsLifecyclePolicy(object x)func IsLifecyclePolicy(X interface{}) *boolstatic#Return whether the given object is a LifecyclePolicy.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#Check whether the given construct is a Resource.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.