interface AmazonLinuxImageSsmParameterBaseProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.EC2.AmazonLinuxImageSsmParameterBaseProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsec2#AmazonLinuxImageSsmParameterBaseProps |
Java | software.amazon.awscdk.services.ec2.AmazonLinuxImageSsmParameterBaseProps |
Python | aws_cdk.aws_ec2.AmazonLinuxImageSsmParameterBaseProps |
TypeScript (source) | aws-cdk-lib » aws_ec2 » AmazonLinuxImageSsmParameterBaseProps |
Base properties for an Amazon Linux SSM Parameter.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
declare const userData: ec2.UserData;
const amazonLinuxImageSsmParameterBaseProps: ec2.AmazonLinuxImageSsmParameterBaseProps = {
parameterName: 'parameterName',
// the properties below are optional
cachedInContext: false,
userData: userData,
};
Properties
Name | Type | Description |
---|---|---|
parameter | string | The name of the SSM parameter that contains the AMI value. |
cached | boolean | Whether the AMI ID is cached to be stable between deployments. |
user | User | Initial user data. |
parameterName
Type:
string
The name of the SSM parameter that contains the AMI value.
cachedInContext?
Type:
boolean
(optional, default: false)
Whether the AMI ID is cached to be stable between deployments.
By default, the newest image is used on each deployment. This will cause instances to be replaced whenever a new version is released, and may cause downtime if there aren't enough running instances in the AutoScalingGroup to reschedule the tasks on.
If set to true, the AMI ID will be cached in cdk.context.json
and the
same value will be used on future runs. Your instances will not be replaced
but your AMI version will grow old over time. To refresh the AMI lookup,
you will have to evict the value from the cache using the cdk context
command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for
more information.
Can not be set to true
in environment-agnostic stacks.
userData?
Type:
User
(optional, default: Empty UserData for Linux machines)
Initial user data.