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.104.0 (build e79254c)",
           date="2024-11-21T06:34:09.381Z")
@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 option settings for the infrastructure configuration.
String	getInstanceProfileName()	The instance profile of the infrastructure configuration.
default List<String>	getInstanceTypes()	The instance types of the infrastructure configuration.
default String	getKeyPair()	The Amazon EC2 key pair of the infrastructure configuration.
default Object	getLogging()	The logging configuration defines where Image Builder uploads your logs.
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 tags attached to the resource created by Image Builder.
default List<String>	getSecurityGroupIds()	The security group IDs of the infrastructure configuration.
default String	getSnsTopicArn()	The Amazon Resource Name (ARN) of the SNS topic for the infrastructure configuration.
default String	getSubnetId()	The subnet ID of the infrastructure configuration.
default Map<String,String>	getTags()	The tags of the infrastructure configuration.
default Object	getTerminateInstanceOnFailure()	The terminate instance on failure configuration 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 of the infrastructure configuration.

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 option settings for the infrastructure configuration.

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.

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 Amazon EC2 key pair of the infrastructure configuration.

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 defines where Image Builder uploads your logs.

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.

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 tags attached to the resource created by Image Builder.

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 of the infrastructure configuration.

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) of the SNS topic for the infrastructure configuration.

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 of the infrastructure configuration.

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 tags of the infrastructure configuration.

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 configuration of the infrastructure configuration.

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