CfnInfrastructureConfiguration

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.imagebuilder.CfnInfrastructureConfiguration

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:46.985Z")
public class CfnInfrastructureConfiguration
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ImageBuilder::InfrastructureConfiguration`.

The infrastructure configuration allows you to specify the infrastructure within which to build and test your image. In the infrastructure configuration, you can specify instance types, subnets, and security groups to associate with your instance. You can also associate an Amazon EC2 key pair with the instance used to build your image. This allows you to log on to your instance to troubleshoot if your build fails and you set terminateInstanceOnFailure to false.

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())
         .resourceTags(Map.of(
                 "resourceTagsKey", "resourceTags"))
         .securityGroupIds(List.of("securityGroupIds"))
         .snsTopicArn("snsTopicArn")
         .subnetId("subnetId")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .terminateInstanceOnFailure(false)
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnInfrastructureConfiguration.Builder` A fluent builder for `CfnInfrastructureConfiguration`.
`static interface`	`CfnInfrastructureConfiguration.InstanceMetadataOptionsProperty` The instance metadata options that apply to the HTTP requests that pipeline builds use to launch EC2 build and test instances.
`static interface`	`CfnInfrastructureConfiguration.LoggingProperty` Logging configuration defines where Image Builder uploads your logs.
`static interface`	`CfnInfrastructureConfiguration.S3LogsProperty` Amazon S3 logging configuration.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnInfrastructureConfiguration(Construct scope, java.lang.String id, CfnInfrastructureConfigurationProps props)` Create a new `AWS::ImageBuilder::InfrastructureConfiguration`.
`protected`	`CfnInfrastructureConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnInfrastructureConfiguration(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrArn()` Returns the Amazon Resource Name (ARN) of the infrastructure configuration.
`java.lang.String`	`getAttrName()` The name of the infrastructure configuration.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getDescription()` The description of the infrastructure configuration.
`java.lang.Object`	`getInstanceMetadataOptions()` The instance metadata option settings for the infrastructure configuration.
`java.lang.String`	`getInstanceProfileName()` The instance profile of the infrastructure configuration.
`java.util.List<java.lang.String>`	`getInstanceTypes()` The instance types of the infrastructure configuration.
`java.lang.String`	`getKeyPair()` The Amazon EC2 key pair of the infrastructure configuration.
`java.lang.Object`	`getLogging()` The logging configuration defines where Image Builder uploads your logs.
`java.lang.String`	`getName()` The name of the infrastructure configuration.
`java.lang.Object`	`getResourceTags()` The tags attached to the resource created by Image Builder.
`java.util.List<java.lang.String>`	`getSecurityGroupIds()` The security group IDs of the infrastructure configuration.
`java.lang.String`	`getSnsTopicArn()` The Amazon Resource Name (ARN) of the SNS topic for the infrastructure configuration.
`java.lang.String`	`getSubnetId()` The subnet ID of the infrastructure configuration.
`TagManager`	`getTags()` The tags of the infrastructure configuration.
`java.lang.Object`	`getTerminateInstanceOnFailure()` The terminate instance on failure configuration of the infrastructure configuration.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setDescription(java.lang.String value)` The description of the infrastructure configuration.
`void`	`setInstanceMetadataOptions(CfnInfrastructureConfiguration.InstanceMetadataOptionsProperty value)` The instance metadata option settings for the infrastructure configuration.
`void`	`setInstanceMetadataOptions(IResolvable value)` The instance metadata option settings for the infrastructure configuration.
`void`	`setInstanceProfileName(java.lang.String value)` The instance profile of the infrastructure configuration.
`void`	`setInstanceTypes(java.util.List<java.lang.String> value)` The instance types of the infrastructure configuration.
`void`	`setKeyPair(java.lang.String value)` The Amazon EC2 key pair of the infrastructure configuration.
`void`	`setLogging(CfnInfrastructureConfiguration.LoggingProperty value)` The logging configuration defines where Image Builder uploads your logs.
`void`	`setLogging(IResolvable value)` The logging configuration defines where Image Builder uploads your logs.
`void`	`setName(java.lang.String value)` The name of the infrastructure configuration.
`void`	`setResourceTags(IResolvable value)` The tags attached to the resource created by Image Builder.
`void`	`setResourceTags(java.util.Map<java.lang.String,java.lang.String> value)` The tags attached to the resource created by Image Builder.
`void`	`setSecurityGroupIds(java.util.List<java.lang.String> value)` The security group IDs of the infrastructure configuration.
`void`	`setSnsTopicArn(java.lang.String value)` The Amazon Resource Name (ARN) of the SNS topic for the infrastructure configuration.
`void`	`setSubnetId(java.lang.String value)` The subnet ID of the infrastructure configuration.
`void`	`setTerminateInstanceOnFailure(java.lang.Boolean value)` The terminate instance on failure configuration of the infrastructure configuration.
`void`	`setTerminateInstanceOnFailure(IResolvable value)` The terminate instance on failure configuration of the infrastructure configuration.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnInfrastructureConfiguration
```
protected CfnInfrastructureConfiguration(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnInfrastructureConfiguration
```
protected CfnInfrastructureConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnInfrastructureConfiguration
```
public CfnInfrastructureConfiguration(Construct scope,
                                      java.lang.String id,
                                      CfnInfrastructureConfigurationProps props)
```
    Create a new `AWS::ImageBuilder::InfrastructureConfiguration`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.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
```
public java.lang.String getAttrName()
```
    The name of the infrastructure configuration.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    The tags of the infrastructure configuration.
  - getInstanceProfileName
```
public java.lang.String getInstanceProfileName()
```
    The instance profile of the infrastructure configuration.
  - setInstanceProfileName
```
public void setInstanceProfileName(java.lang.String value)
```
    The instance profile of the infrastructure configuration.
  - getName
```
public java.lang.String getName()
```
    The name of the infrastructure configuration.
  - setName
```
public void setName(java.lang.String value)
```
    The name of the infrastructure configuration.
  - getDescription
```
public java.lang.String getDescription()
```
    The description of the infrastructure configuration.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    The description of the infrastructure configuration.
  - getInstanceMetadataOptions
```
public java.lang.Object getInstanceMetadataOptions()
```
    The instance metadata option settings for the infrastructure configuration.
  - setInstanceMetadataOptions
```
public void setInstanceMetadataOptions(IResolvable value)
```
    The instance metadata option settings for the infrastructure configuration.
  - setInstanceMetadataOptions
```
public void setInstanceMetadataOptions(CfnInfrastructureConfiguration.InstanceMetadataOptionsProperty value)
```
    The instance metadata option settings for the infrastructure configuration.
  - getInstanceTypes
```
public java.util.List<java.lang.String> getInstanceTypes()
```
    The instance types of the infrastructure configuration.
  - setInstanceTypes
```
public void setInstanceTypes(java.util.List<java.lang.String> value)
```
    The instance types of the infrastructure configuration.
  - getKeyPair
```
public java.lang.String getKeyPair()
```
    The Amazon EC2 key pair of the infrastructure configuration.
  - setKeyPair
```
public void setKeyPair(java.lang.String value)
```
    The Amazon EC2 key pair of the infrastructure configuration.
  - getLogging
```
public java.lang.Object getLogging()
```
    The logging configuration defines where Image Builder uploads your logs.
  - setLogging
```
public void setLogging(IResolvable value)
```
    The logging configuration defines where Image Builder uploads your logs.
  - setLogging
```
public void setLogging(CfnInfrastructureConfiguration.LoggingProperty value)
```
    The logging configuration defines where Image Builder uploads your logs.
  - getResourceTags
```
public java.lang.Object getResourceTags()
```
    The tags attached to the resource created by Image Builder.
  - setResourceTags
```
public void setResourceTags(IResolvable value)
```
    The tags attached to the resource created by Image Builder.
  - setResourceTags
```
public void setResourceTags(java.util.Map<java.lang.String,java.lang.String> value)
```
    The tags attached to the resource created by Image Builder.
  - getSecurityGroupIds
```
public java.util.List<java.lang.String> getSecurityGroupIds()
```
    The security group IDs of the infrastructure configuration.
  - setSecurityGroupIds
```
public void setSecurityGroupIds(java.util.List<java.lang.String> value)
```
    The security group IDs of the infrastructure configuration.
  - getSnsTopicArn
```
public java.lang.String getSnsTopicArn()
```
    The Amazon Resource Name (ARN) of the SNS topic for the infrastructure configuration.
  - setSnsTopicArn
```
public void setSnsTopicArn(java.lang.String value)
```
    The Amazon Resource Name (ARN) of the SNS topic for the infrastructure configuration.
  - getSubnetId
```
public java.lang.String getSubnetId()
```
    The subnet ID of the infrastructure configuration.
  - setSubnetId
```
public void setSubnetId(java.lang.String value)
```
    The subnet ID of the infrastructure configuration.
  - getTerminateInstanceOnFailure
```
public java.lang.Object getTerminateInstanceOnFailure()
```
    The terminate instance on failure configuration of the infrastructure configuration.
  - setTerminateInstanceOnFailure
```
public void setTerminateInstanceOnFailure(java.lang.Boolean value)
```
    The terminate instance on failure configuration of the infrastructure configuration.
  - setTerminateInstanceOnFailure
```
public void setTerminateInstanceOnFailure(IResolvable value)
```
    The terminate instance on failure configuration of the infrastructure configuration.

Class CfnInfrastructureConfiguration

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnInfrastructureConfiguration

CfnInfrastructureConfiguration

CfnInfrastructureConfiguration

Method Detail

inspect

renderProperties

getAttrArn

getAttrName

getCfnProperties

getTags

getInstanceProfileName

setInstanceProfileName

getName

setName

getDescription

setDescription

getInstanceMetadataOptions

setInstanceMetadataOptions

setInstanceMetadataOptions

getInstanceTypes

setInstanceTypes

getKeyPair

setKeyPair

getLogging

setLogging

setLogging

getResourceTags

setResourceTags

setResourceTags

getSecurityGroupIds

setSecurityGroupIds

getSnsTopicArn

setSnsTopicArn

getSubnetId

setSubnetId

getTerminateInstanceOnFailure

setTerminateInstanceOnFailure

setTerminateInstanceOnFailure