Package software.amazon.awscdk.services.imagebuilder

Interface CfnInfrastructureConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInfrastructureConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:07.317Z")
@Stability(Stable)
public interface CfnInfrastructureConfigurationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnInfrastructureConfiguration.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.imagebuilder.*;
 CfnInfrastructureConfigurationProps cfnInfrastructureConfigurationProps = CfnInfrastructureConfigurationProps.builder()
         .instanceProfileName("instanceProfileName")
         .name("name")
         // the properties below are optional
         .description("description")
         .instanceMetadataOptions(InstanceMetadataOptionsProperty.builder()
                 .httpPutResponseHopLimit(123)
                 .httpTokens("httpTokens")
                 .build())
         .instanceTypes(List.of("instanceTypes"))
         .keyPair("keyPair")
         .logging(LoggingProperty.builder()
                 .s3Logs(S3LogsProperty.builder()
                         .s3BucketName("s3BucketName")
                         .s3KeyPrefix("s3KeyPrefix")
                         .build())
                 .build())
         .placement(PlacementProperty.builder()
                 .availabilityZone("availabilityZone")
                 .hostId("hostId")
                 .hostResourceGroupArn("hostResourceGroupArn")
                 .tenancy("tenancy")
                 .build())
         .resourceTags(Map.of(
                 "resourceTagsKey", "resourceTags"))
         .securityGroupIds(List.of("securityGroupIds"))
         .snsTopicArn("snsTopicArn")
         .subnetId("subnetId")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .terminateInstanceOnFailure(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnInfrastructureConfigurationProps.Builder	builder()
default String	getDescription()	The description of the infrastructure configuration.
default Object	getInstanceMetadataOptions()	The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.
String	getInstanceProfileName()	The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
default List<String>	getInstanceTypes()	The instance types of the infrastructure configuration.
default String	getKeyPair()	The key pair of the infrastructure configuration.
default Object	getLogging()	The logging configuration of the infrastructure configuration.
String	getName()	The name of the infrastructure configuration.
default Object	getPlacement()	The instance placement settings that define where the instances that are launched from your image will run.
default Object	getResourceTags()	The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process.
default List<String>	getSecurityGroupIds()	The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
default String	getSnsTopicArn()	The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.
default String	getSubnetId()	The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.
default Map<String,String>	getTags()	The metadata tags to assign to the infrastructure configuration resource that Image Builder creates as output.
default Object	getTerminateInstanceOnFailure()	The terminate instance on failure setting of the infrastructure configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceProfileName

@Stability(Stable)
@NotNull
String getInstanceProfileName()

The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-instanceprofilename

getName

@Stability(Stable)
@NotNull
String getName()

The name of the infrastructure configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-name

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the infrastructure configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-description

getInstanceMetadataOptions

@Stability(Stable)
@Nullable
default Object getInstanceMetadataOptions()

The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.

Returns union: either IResolvable or CfnInfrastructureConfiguration.InstanceMetadataOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-instancemetadataoptions

getInstanceTypes

@Stability(Stable)
@Nullable
default List<String> getInstanceTypes()

The instance types of the infrastructure configuration.

You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-instancetypes

getKeyPair

@Stability(Stable)
@Nullable
default String getKeyPair()

The key pair of the infrastructure configuration.

You can use this to log on to and debug the instance used to create your image.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-keypair

getLogging

@Stability(Stable)
@Nullable
default Object getLogging()

The logging configuration of the infrastructure configuration.

Returns union: either IResolvable or CfnInfrastructureConfiguration.LoggingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-logging

getPlacement

@Stability(Stable)
@Nullable
default Object getPlacement()

The instance placement settings that define where the instances that are launched from your image will run.

Returns union: either IResolvable or CfnInfrastructureConfiguration.PlacementProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-placement

getResourceTags

@Stability(Stable)
@Nullable
default Object getResourceTags()

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

Tags are formatted as key value pairs.

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-resourcetags

getSecurityGroupIds

@Stability(Stable)
@Nullable
default List<String> getSecurityGroupIds()

The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-securitygroupids

getSnsTopicArn

@Stability(Stable)
@Nullable
default String getSnsTopicArn()

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-snstopicarn

getSubnetId

@Stability(Stable)
@Nullable
default String getSubnetId()

The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-subnetid

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

The metadata tags to assign to the infrastructure configuration resource that Image Builder creates as output.

Tags are formatted as key value pairs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-tags

getTerminateInstanceOnFailure

@Stability(Stable)
@Nullable
default Object getTerminateInstanceOnFailure()

The terminate instance on failure setting of the infrastructure configuration.

Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-terminateinstanceonfailure

builder

@Stability(Stable)
static CfnInfrastructureConfigurationProps.Builder builder()

Returns:

a CfnInfrastructureConfigurationProps.Builder of CfnInfrastructureConfigurationProps