software.amazon.awscdk.services.imagebuilder

Interface CfnInfrastructureConfigurationProps

All Known Implementing Classes:

CfnInfrastructureConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:22.347Z")
public interface CfnInfrastructureConfigurationProps

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())
         .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	Interface and Description
static class	CfnInfrastructureConfigurationProps.Builder A builder for CfnInfrastructureConfigurationProps
static class	CfnInfrastructureConfigurationProps.Jsii$Proxy An implementation for CfnInfrastructureConfigurationProps

Method Summary

Modifier and Type	Method and Description
static CfnInfrastructureConfigurationProps.Builder	builder()
default java.lang.String	getDescription() The description of the infrastructure configuration.
default java.lang.Object	getInstanceMetadataOptions() The instance metadata option settings for the infrastructure configuration.
java.lang.String	getInstanceProfileName() The instance profile of the infrastructure configuration.
default java.util.List<java.lang.String>	getInstanceTypes() The instance types of the infrastructure configuration.
default java.lang.String	getKeyPair() The Amazon EC2 key pair of the infrastructure configuration.
default java.lang.Object	getLogging() The logging configuration defines where Image Builder uploads your logs.
java.lang.String	getName() The name of the infrastructure configuration.
default java.lang.Object	getResourceTags() The tags attached to the resource created by Image Builder.
default java.util.List<java.lang.String>	getSecurityGroupIds() The security group IDs of the infrastructure configuration.
default java.lang.String	getSnsTopicArn() The Amazon Resource Name (ARN) of the SNS topic for the infrastructure configuration.
default java.lang.String	getSubnetId() The subnet ID of the infrastructure configuration.
default java.util.Map<java.lang.String,java.lang.String>	getTags() The tags of the infrastructure configuration.
default java.lang.Object	getTerminateInstanceOnFailure() The terminate instance on failure configuration of the infrastructure configuration.

Method Detail

getInstanceProfileName

java.lang.String getInstanceProfileName()

The instance profile of the infrastructure configuration.

getName

java.lang.String getName()

The name of the infrastructure configuration.

getDescription

default java.lang.String getDescription()

The description of the infrastructure configuration.

getInstanceMetadataOptions

default java.lang.Object getInstanceMetadataOptions()

The instance metadata option settings for the infrastructure configuration.

getInstanceTypes

default java.util.List<java.lang.String> getInstanceTypes()

The instance types of the infrastructure configuration.

getKeyPair

default java.lang.String getKeyPair()

The Amazon EC2 key pair of the infrastructure configuration.

getLogging

default java.lang.Object getLogging()

The logging configuration defines where Image Builder uploads your logs.

getResourceTags

default java.lang.Object getResourceTags()

The tags attached to the resource created by Image Builder.

getSecurityGroupIds

default java.util.List<java.lang.String> getSecurityGroupIds()

The security group IDs of the infrastructure configuration.

getSnsTopicArn

default java.lang.String getSnsTopicArn()

The Amazon Resource Name (ARN) of the SNS topic for the infrastructure configuration.

getSubnetId

default java.lang.String getSubnetId()

The subnet ID of the infrastructure configuration.

getTags

default java.util.Map<java.lang.String,java.lang.String> getTags()

The tags of the infrastructure configuration.

getTerminateInstanceOnFailure

default java.lang.Object getTerminateInstanceOnFailure()

The terminate instance on failure configuration of the infrastructure configuration.

builder

static CfnInfrastructureConfigurationProps.Builder builder()

Returns:

a CfnInfrastructureConfigurationProps.Builder of CfnInfrastructureConfigurationProps