AWS::ImageBuilder::LifecyclePolicy
Create a lifecycle policy resource.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::ImageBuilder::LifecyclePolicy", "Properties" : { "Description" :
String
, "ExecutionRole" :String
, "Name" :String
, "PolicyDetails" :[ PolicyDetail, ... ]
, "ResourceSelection" :ResourceSelection
, "ResourceType" :String
, "Status" :String
, "Tags" :{
} }Key
:Value
, ...}
YAML
Type: AWS::ImageBuilder::LifecyclePolicy Properties: Description:
String
ExecutionRole:String
Name:String
PolicyDetails:- PolicyDetail
ResourceSelection:ResourceSelection
ResourceType:String
Status:String
Tags:
Key
:Value
Properties
Description
-
Optional description for the lifecycle policy.
Required: No
Type: String
Minimum:
1
Maximum:
1024
Update requires: No interruption
ExecutionRole
-
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions.
Required: Yes
Type: String
Pattern:
^(?:arn:aws(?:-[a-z]+)*:iam::[0-9]{12}:role/)?[a-zA-Z_0-9+=,.@\-_/]+$
Minimum:
1
Maximum:
2048
Update requires: No interruption
Name
-
The name of the lifecycle policy to create.
Required: Yes
Type: String
Pattern:
^[-_A-Za-z-0-9][-_A-Za-z0-9 ]{1,126}[-_A-Za-z-0-9]$
Update requires: Replacement
PolicyDetails
-
Configuration details for the lifecycle policy rules.
Required: Yes
Type: Array of PolicyDetail
Minimum:
1
Maximum:
3
Update requires: No interruption
ResourceSelection
-
Selection criteria for the resources that the lifecycle policy applies to.
Required: Yes
Type: ResourceSelection
Update requires: No interruption
ResourceType
-
The type of Image Builder resource that the lifecycle policy applies to.
Required: Yes
Type: String
Allowed values:
AMI_IMAGE | CONTAINER_IMAGE
Update requires: No interruption
Status
-
Indicates whether the lifecycle policy resource is enabled.
Required: No
Type: String
Allowed values:
DISABLED | ENABLED
Update requires: No interruption
-
Tags to apply to the lifecycle policy resource.
Required: No
Type: Object of String
Pattern:
.{1,}
Update requires: No interruption
Return values
Ref
Fn::GetAtt
Arn
-
The Amazon Resource Name (ARN) of the lifecycle policy resource.