Package software.amazon.awscdk.services.imagebuilder

Class CfnInfrastructureConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.imagebuilder.CfnInfrastructureConfiguration
All Implemented Interfaces:
IInspectable, ITaggable, IInfrastructureConfigurationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:39.949Z") @Stability(Stable) public class CfnInfrastructureConfiguration extends CfnResource implements IInspectable, IInfrastructureConfigurationRef, ITaggable
Creates a new infrastructure configuration.

An infrastructure configuration defines the environment in which your image will be built and tested.

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.*;
 CfnInfrastructureConfiguration cfnInfrastructureConfiguration = CfnInfrastructureConfiguration.Builder.create(this, "MyCfnInfrastructureConfiguration")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnInfrastructureConfiguration

      protected CfnInfrastructureConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnInfrastructureConfiguration

      protected CfnInfrastructureConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnInfrastructureConfiguration

      @Stability(Stable) public CfnInfrastructureConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnInfrastructureConfigurationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Returns the Amazon Resource Name (ARN) of the infrastructure configuration.

      The following pattern is applied: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:\d{12}|aws):(?:image-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|\d+)\.(?:x|\d+)\.(?:x|\d+))(?:/\d+)?)?$ .

    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      The name of the infrastructure configuration.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getInfrastructureConfigurationRef

      @Stability(Stable) @NotNull public InfrastructureConfigurationReference getInfrastructureConfigurationRef()
      A reference to a InfrastructureConfiguration resource.
      Specified by:
      getInfrastructureConfigurationRef in interface IInfrastructureConfigurationRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getInstanceProfileName

      @Stability(Stable) @NotNull public String getInstanceProfileName()
      The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

    • setInstanceProfileName

      @Stability(Stable) public void setInstanceProfileName(@NotNull String value)
      The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the infrastructure configuration.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the infrastructure configuration.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the infrastructure configuration.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the infrastructure configuration.

    • getInstanceMetadataOptions

      @Stability(Stable) @Nullable public 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

    • setInstanceMetadataOptions

      @Stability(Stable) public void setInstanceMetadataOptions(@Nullable IResolvable value)
      The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.

    • setInstanceMetadataOptions

      @Stability(Stable) public void setInstanceMetadataOptions(@Nullable CfnInfrastructureConfiguration.InstanceMetadataOptionsProperty value)
      The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.

    • getInstanceTypes

      @Stability(Stable) @Nullable public List<String> getInstanceTypes()
      The instance types of the infrastructure configuration.

    • setInstanceTypes

      @Stability(Stable) public void setInstanceTypes(@Nullable List<String> value)
      The instance types of the infrastructure configuration.

    • getKeyPair

      @Stability(Stable) @Nullable public String getKeyPair()
      The key pair of the infrastructure configuration.

    • setKeyPair

      @Stability(Stable) public void setKeyPair(@Nullable String value)
      The key pair of the infrastructure configuration.

    • getLogging

      @Stability(Stable) @Nullable public Object getLogging()
      The logging configuration of the infrastructure configuration.

      Returns union: either IResolvable or CfnInfrastructureConfiguration.LoggingProperty

    • setLogging

      @Stability(Stable) public void setLogging(@Nullable IResolvable value)
      The logging configuration of the infrastructure configuration.

    • setLogging

      @Stability(Stable) public void setLogging(@Nullable CfnInfrastructureConfiguration.LoggingProperty value)
      The logging configuration of the infrastructure configuration.

    • getPlacement

      @Stability(Stable) @Nullable public 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

    • setPlacement

      @Stability(Stable) public void setPlacement(@Nullable IResolvable value)
      The instance placement settings that define where the instances that are launched from your image will run.

    • setPlacement

      @Stability(Stable) public void setPlacement(@Nullable CfnInfrastructureConfiguration.PlacementProperty value)
      The instance placement settings that define where the instances that are launched from your image will run.

    • getResourceTags

      @Stability(Stable) @Nullable public Object getResourceTags()
      The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process.

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

    • setResourceTags

      @Stability(Stable) public void setResourceTags(@Nullable Map<String,String> value)
      The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process.

    • setResourceTags

      @Stability(Stable) public void setResourceTags(@Nullable IResolvable value)
      The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process.

    • getSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getSecurityGroupIds()
      The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@Nullable List<String> value)
      The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

    • getSnsTopicArn

      @Stability(Stable) @Nullable public String getSnsTopicArn()
      The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

    • setSnsTopicArn

      @Stability(Stable) public void setSnsTopicArn(@Nullable String value)
      The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

    • getSubnetId

      @Stability(Stable) @Nullable public String getSubnetId()
      The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.

    • setSubnetId

      @Stability(Stable) public void setSubnetId(@Nullable String value)
      The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.

    • getTagsRaw

      @Stability(Stable) @Nullable public Map<String,String> getTagsRaw()
      The metadata tags to assign to the infrastructure configuration resource that Image Builder creates as output.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Map<String,String> value)
      The metadata tags to assign to the infrastructure configuration resource that Image Builder creates as output.

    • getTerminateInstanceOnFailure

      @Stability(Stable) @Nullable public Object getTerminateInstanceOnFailure()
      The terminate instance on failure setting of the infrastructure configuration.

      Returns union: either Boolean or IResolvable

    • setTerminateInstanceOnFailure

      @Stability(Stable) public void setTerminateInstanceOnFailure(@Nullable Boolean value)
      The terminate instance on failure setting of the infrastructure configuration.

    • setTerminateInstanceOnFailure

      @Stability(Stable) public void setTerminateInstanceOnFailure(@Nullable IResolvable value)
      The terminate instance on failure setting of the infrastructure configuration.