@aws-cdk/aws-imagebuilder-alpha.InfrastructureConfigurationProps

InfrastructureConfigurationProps Struct

Properties for creating an Infrastructure Configuration resource.

Stability

Experimental

Source

lib/infrastructure-configuration.ts

Example

const infrastructureConfiguration = new imagebuilder.InfrastructureConfiguration(this, 'Infrastructure', {
  infrastructureConfigurationName: 'production-infrastructure',
  instanceTypes: [
    ec2.InstanceType.of(ec2.InstanceClass.COMPUTE7_INTEL, ec2.InstanceSize.LARGE)
  ],
  vpc: vpc,
  subnetSelection: { subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS }
});

const distributionConfiguration = new imagebuilder.DistributionConfiguration(this, 'Distribution');
distributionConfiguration.addAmiDistributions({
  amiName: 'production-ami-{{ imagebuilder:buildDate }}',
  amiTargetAccountIds: ['123456789012', '098765432109']
});

const productionPipeline = new imagebuilder.ImagePipeline(this, 'ProductionPipeline', {
  recipe: exampleImageRecipe,
  infrastructureConfiguration: infrastructureConfiguration,
  distributionConfiguration: distributionConfiguration
});

Properties

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= None#

The description of the infrastructure configuration.

ec2InstanceAvailabilityZonestringec2_instance_availability_zonestrec2InstanceAvailabilityZoneStringEc2InstanceAvailabilityZonestringEc2InstanceAvailabilityZone*string= EC2 will select a random zone#

The availability zone to place Image Builder build and test EC2 instances.

ec2InstanceHostIdstringec2_instance_host_idstrec2InstanceHostIdStringEc2InstanceHostIdstringEc2InstanceHostId*string= None#

The ID of the Dedicated Host on which build and test instances run.

This only applies if the instance tenancy is host. This cannot be used with the ec2InstanceHostResourceGroupArn parameter.

ec2InstanceHostResourceGroupArnstringec2_instance_host_resource_group_arnstrec2InstanceHostResourceGroupArnStringEc2InstanceHostResourceGroupArnstringEc2InstanceHostResourceGroupArn*string= None#

The ARN of the host resource group on which build and test instances run.

This only applies if the instance tenancy is host. This cannot be used with the ec2InstanceHostId parameter.

ec2InstanceTenancyTenancyec2_instance_tenancyTenancyec2InstanceTenancyTenancyEc2InstanceTenancyTenancyEc2InstanceTenancyTenancy= Tenancy.DEFAULT#

The tenancy of the instance.

Dedicated tenancy runs instances on single-tenant hardware, while host tenancy runs instances on a dedicated host. Shared tenancy is used by default.

httpPutResponseHopLimitnumberhttp_put_response_hop_limitint | floathttpPutResponseHopLimitNumberHttpPutResponseHopLimitdoubleHttpPutResponseHopLimit*float64= 2#

The maximum number of hops that an instance metadata request can traverse to reach its destination.

By default, this is set to 2.

httpTokensHttpTokenshttp_tokensHttpTokenshttpTokensHttpTokensHttpTokensHttpTokensHttpTokensHttpTokens= HttpTokens.REQUIRED#

Indicates whether a signed token header is required for instance metadata retrieval requests.

By default, this is set to required to require IMDSv2 on build and test EC2 instances.

infrastructureConfigurationNamestringinfrastructure_configuration_namestrinfrastructureConfigurationNameStringInfrastructureConfigurationNamestringInfrastructureConfigurationName*string= A name is generated#

The name of the infrastructure configuration.

This name must be normalized by transforming all alphabetical characters to lowercase, and replacing all spaces and underscores with hyphens.

instanceProfileIInstanceProfileinstance_profileIInstanceProfileinstanceProfileIInstanceProfileInstanceProfileIInstanceProfileInstanceProfileIInstanceProfile= An instance profile will be gene…#

The instance profile to associate with the instance used to customize the AMI.

notes · default

By default, an instance profile and role will be created with minimal permissions needed to build the image, attached to the EC2 instance.

If an S3 logging bucket and key prefix is provided, an IAM inline policy will be attached to the instance profile's role, allowing s3:PutObject permissions on the bucket.

Default: An instance profile will be generated

instanceTypesInstanceType[]instance_typestyping.List[InstanceType]instanceTypesList<InstanceType>InstanceTypesInstanceType[]InstanceTypes*[]InstanceType= Image Builder will choose from a…#

The instance types to launch build and test EC2 instances with.

default

Default: Image Builder will choose from a default set of instance types compatible with the AMI

keyPairIKeyPairkey_pairIKeyPairkeyPairIKeyPairKeyPairIKeyPairKeyPairIKeyPair= None#

The key pair used to connect to the build and test EC2 instances.

The key pair can be used to log into the build or test instances for troubleshooting any failures.

loggingInfrastructureConfigurationLoggingloggingInfrastructureConfigurationLoggingloggingInfrastructureConfigurationLoggingLoggingInfrastructureConfigurationLoggingLoggingInfrastructureConfigurationLogging= None#

The log settings for detailed build logging.

notificationTopicITopicnotification_topicITopicnotificationTopicITopicNotificationTopicITopicNotificationTopicITopic= No notifications are sent#

The SNS topic on which notifications are sent when an image build completes.

resourceTags{ [key: string]: string }resource_tagstyping.Mapping[str, str]resourceTagsMap<String, String>ResourceTagsIDictionary<string, string>ResourceTags*map[string]*string= None#

The additional tags to assign to the Amazon EC2 instance that Image Builder launches during the build process.

roleIRoleroleIRoleroleIRoleRoleIRoleRoleIRole= A role will automatically be cre…#

An IAM role to associate with the instance profile used by Image Builder.

The role must be assumable by the service principal ec2.amazonaws.com: Note: You can provide an instanceProfile or a role, but not both.

default · example

Default: A role will automatically be created, it can be accessed via the role property

const instanceProfileRole = new iam.Role(this, 'MyRole', {
  assumedBy: new iam.ServicePrincipal('ec2.amazonaws.com')
});

securityGroupsISecurityGroup[]security_groupstyping.List[ISecurityGroup]securityGroupsList<ISecurityGroup>SecurityGroupsISecurityGroup[]SecurityGroups*[]ISecurityGroup= The default security group for t…#

The security groups to associate with the instance used to customize the AMI.

default

Default: The default security group for the VPC will be used

subnetSelectionSubnetSelectionsubnet_selectionSubnetSelectionsubnetSelectionSubnetSelectionSubnetSelectionSubnetSelectionSubnetSelectionSubnetSelection= The first subnet selected from t…#

Select which subnet to place the instance used to customize the AMI.

The first subnet that is selected will be used. You must specify the VPC to customize the subnet selection.

default

Default: The first subnet selected from the provided VPC will be used

tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string= None#

The tags to apply to the infrastructure configuration.

terminateInstanceOnFailurebooleanterminate_instance_on_failureboolterminateInstanceOnFailureBooleanTerminateInstanceOnFailureboolTerminateInstanceOnFailure*bool= true#

Whether to terminate the EC2 instance when the build or test workflow fails.

vpcIVpcvpcIVpcvpcIVpcVpcIVpcVpcIVpc= The default VPC will be used#

The VPC to place the instance used to customize the AMI.

Used as props by

• InfrastructureConfiguration