AWS CDK Reference

Appearance

v2.273.0

AmazonLinux2ImageSsmParameter Class ​

A SSM Parameter that contains the AMI ID for Amazon Linux 2.

Source
aws-ec2/lib/machine-image/amazon-linux2.ts
Type last changed
v2.76.0 · 20 Apr 2023

Example ​

ts
// 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 amazonLinux2Kernel: ec2.AmazonLinux2Kernel;
declare const userData: ec2.UserData;
const amazonLinux2ImageSsmParameter = new ec2.AmazonLinux2ImageSsmParameter({
  additionalCacheKey: 'additionalCacheKey',
  cachedInContext: false,
  cpuType: ec2.AmazonLinuxCpuType.ARM_64,
  edition: ec2.AmazonLinuxEdition.STANDARD,
  kernel: amazonLinux2Kernel,
  storage: ec2.AmazonLinuxStorage.EBS,
  userData: userData,
  virtualization: ec2.AmazonLinuxVirt.HVM,
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2

# amazon_linux2_kernel: ec2.AmazonLinux2Kernel
# user_data: ec2.UserData

amazon_linux2_image_ssm_parameter = ec2.AmazonLinux2ImageSsmParameter(
    additional_cache_key="additionalCacheKey",
    cached_in_context=False,
    cpu_type=ec2.AmazonLinuxCpuType.ARM_64,
    edition=ec2.AmazonLinuxEdition.STANDARD,
    kernel=amazon_linux2_kernel,
    storage=ec2.AmazonLinuxStorage.EBS,
    user_data=user_data,
    virtualization=ec2.AmazonLinuxVirt.HVM
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ec2.*;

AmazonLinux2Kernel amazonLinux2Kernel;
UserData userData;

AmazonLinux2ImageSsmParameter amazonLinux2ImageSsmParameter = AmazonLinux2ImageSsmParameter.Builder.create()
        .additionalCacheKey("additionalCacheKey")
        .cachedInContext(false)
        .cpuType(AmazonLinuxCpuType.ARM_64)
        .edition(AmazonLinuxEdition.STANDARD)
        .kernel(amazonLinux2Kernel)
        .storage(AmazonLinuxStorage.EBS)
        .userData(userData)
        .virtualization(AmazonLinuxVirt.HVM)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;

AmazonLinux2Kernel amazonLinux2Kernel;
UserData userData;

var amazonLinux2ImageSsmParameter = new AmazonLinux2ImageSsmParameter(new AmazonLinux2ImageSsmParameterProps {
    AdditionalCacheKey = "additionalCacheKey",
    CachedInContext = false,
    CpuType = AmazonLinuxCpuType.ARM_64,
    Edition = AmazonLinuxEdition.STANDARD,
    Kernel = amazonLinux2Kernel,
    Storage = AmazonLinuxStorage.EBS,
    UserData = userData,
    Virtualization = AmazonLinuxVirt.HVM
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// 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"

var amazonLinux2Kernel AmazonLinux2Kernel
var userData UserData

amazonLinux2ImageSsmParameter := awscdk.Aws_ec2.NewAmazonLinux2ImageSsmParameter(&AmazonLinux2ImageSsmParameterProps{
	AdditionalCacheKey: jsii.String("additionalCacheKey"),
	CachedInContext: jsii.Boolean(false),
	CpuType: awscdk.*Aws_ec2.AmazonLinuxCpuType_ARM_64,
	Edition: awscdk.*Aws_ec2.AmazonLinuxEdition_STANDARD,
	Kernel: amazonLinux2Kernel,
	Storage: awscdk.*Aws_ec2.AmazonLinuxStorage_EBS,
	UserData: userData,
	Virtualization: awscdk.*Aws_ec2.AmazonLinuxVirt_HVM,
})

Initializer ​

ts
new AmazonLinux2ImageSsmParameter(props: AmazonLinux2ImageSsmParameterProps)
python
AmazonLinux2ImageSsmParameter(props: AmazonLinux2ImageSsmParameterProps)
java
new AmazonLinux2ImageSsmParameter(AmazonLinux2ImageSsmParameterProps props)
csharp
new AmazonLinux2ImageSsmParameter(AmazonLinux2ImageSsmParameterProps props)
go
NewAmazonLinux2ImageSsmParameter(Props AmazonLinux2ImageSsmParameterProps)

Methods ​

getImage(scope: Construct): MachineImageConfigdef get_image(self, scope: Construct) -> MachineImageConfigpublic MachineImageConfig getImage(Construct scope)public MachineImageConfig GetImage(Construct scope)func GetImage(Scope Construct) MachineImageConfig#
Return the image to use in the given context.
ssmParameterName(props: AmazonLinux2ImageSsmParameterProps): string@staticmethod def ssm_parameter_name(props: AmazonLinux2ImageSsmParameterProps) -> strpublic static String ssmParameterName(AmazonLinux2ImageSsmParameterProps props)public static string SsmParameterName(AmazonLinux2ImageSsmParameterProps props)func SsmParameterName(Props AmazonLinux2ImageSsmParameterProps) *stringstatic#
Generates a SSM Parameter name for a specific amazon linux 2 AMI.
notes

Example values:

"/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-ebs",
"/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-x86_64-gp2",
"/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-x86_64-ebs",
"/aws/service/ami-amazon-linux-latest/amzn2-ami-hvm-arm64-gp2",
"/aws/service/ami-amazon-linux-latest/amzn2-ami-minimal-hvm-arm64-ebs",
"/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-arm64-gp2",
"/aws/service/ami-amazon-linux-latest/amzn2-ami-kernel-5.10-hvm-x86_64-gp2",
"/aws/service/ami-amazon-linux-latest/amzn2-ami-minimal-hvm-x86_64-ebs"