interface SsmParameterImageOptions
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.EC2.SsmParameterImageOptions |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsec2#SsmParameterImageOptions |
![]() | software.amazon.awscdk.services.ec2.SsmParameterImageOptions |
![]() | aws_cdk.aws_ec2.SsmParameterImageOptions |
![]() | aws-cdk-lib » aws_ec2 » SsmParameterImageOptions |
Properties for GenericSsmParameterImage.
Example
// Pick the right Amazon Linux edition. All arguments shown are optional
// and will default to these values when omitted.
const amznLinux = ec2.MachineImage.latestAmazonLinux({
generation: ec2.AmazonLinuxGeneration.AMAZON_LINUX,
edition: ec2.AmazonLinuxEdition.STANDARD,
virtualization: ec2.AmazonLinuxVirt.HVM,
storage: ec2.AmazonLinuxStorage.GENERAL_PURPOSE,
cpuType: ec2.AmazonLinuxCpuType.X86_64,
});
// Pick a Windows edition to use
const windows = ec2.MachineImage.latestWindows(ec2.WindowsVersion.WINDOWS_SERVER_2019_ENGLISH_FULL_BASE);
// Read AMI id from SSM parameter store
const ssm = ec2.MachineImage.fromSsmParameter('/my/ami', { os: ec2.OperatingSystemType.LINUX });
// Look up the most recent image matching a set of AMI filters.
// In this case, look up the NAT instance AMI, by using a wildcard
// in the 'name' field:
const natAmi = ec2.MachineImage.lookup({
name: 'amzn-ami-vpc-nat-*',
owners: ['amazon'],
});
// For other custom (Linux) images, instantiate a `GenericLinuxImage` with
// a map giving the AMI to in for each region:
const linux = ec2.MachineImage.genericLinux({
'us-east-1': 'ami-97785bed',
'eu-west-1': 'ami-12345678',
// ...
});
// For other custom (Windows) images, instantiate a `GenericWindowsImage` with
// a map giving the AMI to in for each region:
const genericWindows = ec2.MachineImage.genericWindows({
'us-east-1': 'ami-97785bed',
'eu-west-1': 'ami-12345678',
// ...
});
Properties
Name | Type | Description |
---|---|---|
cached | boolean | Whether the AMI ID is cached to be stable between deployments. |
os? | Operating | Operating system. |
parameter | string | The version of the SSM parameter. |
user | User | Custom UserData. |
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.
os?
Type:
Operating
(optional, default: OperatingSystemType.LINUX)
Operating system.
parameterVersion?
Type:
string
(optional, default: no version specified.)
The version of the SSM parameter.
userData?
Type:
User
(optional, default: UserData appropriate for the OS)
Custom UserData.