software.amazon.awscdk.services.ec2

Interface AmazonLinuxImageProps

All Known Implementing Classes:

AmazonLinuxImageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-13T01:13:32.193Z")
public interface AmazonLinuxImageProps

Amazon Linux image properties.

Example:

 ISecurityGroup sg = SecurityGroup.fromSecurityGroupId(this, "FsxSecurityGroup", "{SECURITY-GROUP-ID}");
 IFileSystem fs = LustreFileSystem.fromLustreFileSystemAttributes(this, "FsxLustreFileSystem", FileSystemAttributes.builder()
         .dnsName("{FILE-SYSTEM-DNS-NAME}")
         .fileSystemId("{FILE-SYSTEM-ID}")
         .securityGroup(sg)
         .build());
 IVpc vpc = Vpc.fromVpcAttributes(this, "Vpc", VpcAttributes.builder()
         .availabilityZones(List.of("us-west-2a", "us-west-2b"))
         .publicSubnetIds(List.of("{US-WEST-2A-SUBNET-ID}", "{US-WEST-2B-SUBNET-ID}"))
         .vpcId("{VPC-ID}")
         .build());
 Instance inst = Instance.Builder.create(this, "inst")
         .instanceType(InstanceType.of(InstanceClass.T2, InstanceSize.LARGE))
         .machineImage(AmazonLinuxImage.Builder.create()
                 .generation(AmazonLinuxGeneration.AMAZON_LINUX_2)
                 .build())
         .vpc(vpc)
         .vpcSubnets(SubnetSelection.builder()
                 .subnetType(SubnetType.PUBLIC)
                 .build())
         .build();
 fs.connections.allowDefaultPortFrom(inst);
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AmazonLinuxImageProps.Builder A builder for AmazonLinuxImageProps
static class	AmazonLinuxImageProps.Jsii$Proxy An implementation for AmazonLinuxImageProps

Method Summary

Modifier and Type	Method and Description
static AmazonLinuxImageProps.Builder	builder()
default java.lang.Boolean	getCachedInContext() Whether the AMI ID is cached to be stable between deployments.
default AmazonLinuxCpuType	getCpuType() CPU Type.
default AmazonLinuxEdition	getEdition() What edition of Amazon Linux to use.
default AmazonLinuxGeneration	getGeneration() What generation of Amazon Linux to use.
default AmazonLinuxKernel	getKernel() What kernel version of Amazon Linux to use.
default AmazonLinuxStorage	getStorage() What storage backed image to use.
default UserData	getUserData() Initial user data.
default AmazonLinuxVirt	getVirtualization() Virtualization type.

Method Detail

getCachedInContext

default java.lang.Boolean getCachedInContext()

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.

Default: false

getCpuType

default AmazonLinuxCpuType getCpuType()

CPU Type.

Default: X86_64

getEdition

default AmazonLinuxEdition getEdition()

What edition of Amazon Linux to use.

Default: Standard

getGeneration

default AmazonLinuxGeneration getGeneration()

What generation of Amazon Linux to use.

Default: AmazonLinux

getKernel

default AmazonLinuxKernel getKernel()

What kernel version of Amazon Linux to use.

Default: -

getStorage

default AmazonLinuxStorage getStorage()

What storage backed image to use.

Default: GeneralPurpose

getUserData

default UserData getUserData()

Initial user data.

Default: - Empty UserData for Linux machines

getVirtualization

default AmazonLinuxVirt getVirtualization()

Virtualization type.

Default: HVM

builder

static AmazonLinuxImageProps.Builder builder()

Returns:

a AmazonLinuxImageProps.Builder of AmazonLinuxImageProps