Package software.amazon.awscdk.cfnpropertymixins.services.imagebuilder

Class CfnInfrastructureConfigurationPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.imagebuilder.CfnInfrastructureConfigurationPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnInfrastructureConfigurationPropsMixin>

Enclosing class:

CfnInfrastructureConfigurationPropsMixin

@Stability(Stable)
public static final class CfnInfrastructureConfigurationPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnInfrastructureConfigurationPropsMixin>

A fluent builder for CfnInfrastructureConfigurationPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnInfrastructureConfigurationPropsMixin	build()
static CfnInfrastructureConfigurationPropsMixin.Builder	create()
static CfnInfrastructureConfigurationPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnInfrastructureConfigurationPropsMixin.Builder	description(String description)	The description of the infrastructure configuration.
CfnInfrastructureConfigurationPropsMixin.Builder	instanceMetadataOptions(CfnInfrastructureConfigurationPropsMixin.InstanceMetadataOptionsProperty instanceMetadataOptions)	The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.
CfnInfrastructureConfigurationPropsMixin.Builder	instanceMetadataOptions(IResolvable instanceMetadataOptions)	The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.
CfnInfrastructureConfigurationPropsMixin.Builder	instanceProfileName(String instanceProfileName)	The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
CfnInfrastructureConfigurationPropsMixin.Builder	instanceProfileName(IInstanceProfileRef instanceProfileName)	The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
CfnInfrastructureConfigurationPropsMixin.Builder	instanceTypes(List<String> instanceTypes)	The instance types of the infrastructure configuration.
CfnInfrastructureConfigurationPropsMixin.Builder	keyPair(String keyPair)	The key pair of the infrastructure configuration.
CfnInfrastructureConfigurationPropsMixin.Builder	logging(CfnInfrastructureConfigurationPropsMixin.LoggingProperty logging)	The logging configuration of the infrastructure configuration.
CfnInfrastructureConfigurationPropsMixin.Builder	logging(IResolvable logging)	The logging configuration of the infrastructure configuration.
CfnInfrastructureConfigurationPropsMixin.Builder	name(String name)	The name of the infrastructure configuration.
CfnInfrastructureConfigurationPropsMixin.Builder	placement(CfnInfrastructureConfigurationPropsMixin.PlacementProperty placement)	The instance placement settings that define where the instances that are launched from your image will run.
CfnInfrastructureConfigurationPropsMixin.Builder	placement(IResolvable placement)	The instance placement settings that define where the instances that are launched from your image will run.
CfnInfrastructureConfigurationPropsMixin.Builder	resourceTags(Map<String,String> resourceTags)	The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process.
CfnInfrastructureConfigurationPropsMixin.Builder	resourceTags(IResolvable resourceTags)	The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process.
CfnInfrastructureConfigurationPropsMixin.Builder	securityGroupIds(List<String> securityGroupIds)	The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
CfnInfrastructureConfigurationPropsMixin.Builder	snsTopicArn(String snsTopicArn)	The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.
CfnInfrastructureConfigurationPropsMixin.Builder	snsTopicArn(ITopicRef snsTopicArn)	The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.
CfnInfrastructureConfigurationPropsMixin.Builder	subnetId(String subnetId)	The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.
CfnInfrastructureConfigurationPropsMixin.Builder	tags(Map<String,String> tags)	The metadata tags to assign to the infrastructure configuration resource that Image Builder creates as output.
CfnInfrastructureConfigurationPropsMixin.Builder	terminateInstanceOnFailure(Boolean terminateInstanceOnFailure)	The terminate instance on failure setting of the infrastructure configuration.
CfnInfrastructureConfigurationPropsMixin.Builder	terminateInstanceOnFailure(IResolvable terminateInstanceOnFailure)	The terminate instance on failure setting of the infrastructure configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnInfrastructureConfigurationPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnInfrastructureConfigurationPropsMixin.Builder.

create

@Stability(Stable)
public static CfnInfrastructureConfigurationPropsMixin.Builder create()

Returns:

a new instance of CfnInfrastructureConfigurationPropsMixin.Builder.

description

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder description(String description)

The description of the infrastructure configuration.

Parameters:

description - The description of the infrastructure configuration. This parameter is required.

Returns:

this

See Also:

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

instanceMetadataOptions

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder instanceMetadataOptions(IResolvable instanceMetadataOptions)

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

Parameters:

instanceMetadataOptions - The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances. This parameter is required.

Returns:

this

See Also:

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

instanceMetadataOptions

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder instanceMetadataOptions(CfnInfrastructureConfigurationPropsMixin.InstanceMetadataOptionsProperty instanceMetadataOptions)

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

Parameters:

instanceMetadataOptions - The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances. This parameter is required.

Returns:

this

See Also:

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

instanceProfileName

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder instanceProfileName(String instanceProfileName)

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

Parameters:

instanceProfileName - The instance profile to associate with the instance used to customize your Amazon EC2 AMI. This parameter is required.

Returns:

this

See Also:

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

instanceProfileName

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder instanceProfileName(IInstanceProfileRef instanceProfileName)

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

Parameters:

instanceProfileName - The instance profile to associate with the instance used to customize your Amazon EC2 AMI. This parameter is required.

Returns:

this

See Also:

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

instanceTypes

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder instanceTypes(List<String> instanceTypes)

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.

Parameters:

instanceTypes - The instance types of the infrastructure configuration. This parameter is required.

Returns:

this

See Also:

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

keyPair

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder keyPair(String keyPair)

The key pair of the infrastructure configuration.

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

Parameters:

keyPair - The key pair of the infrastructure configuration. This parameter is required.

Returns:

this

See Also:

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

logging

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder logging(IResolvable logging)

The logging configuration of the infrastructure configuration.

Parameters:

logging - The logging configuration of the infrastructure configuration. This parameter is required.

Returns:

this

See Also:

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

logging

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder logging(CfnInfrastructureConfigurationPropsMixin.LoggingProperty logging)

The logging configuration of the infrastructure configuration.

Parameters:

logging - The logging configuration of the infrastructure configuration. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder name(String name)

The name of the infrastructure configuration.

Parameters:

name - The name of the infrastructure configuration. This parameter is required.

Returns:

this

See Also:

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

placement

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder placement(IResolvable placement)

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

Parameters:

placement - The instance placement settings that define where the instances that are launched from your image will run. This parameter is required.

Returns:

this

See Also:

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

placement

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder placement(CfnInfrastructureConfigurationPropsMixin.PlacementProperty placement)

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

Parameters:

placement - The instance placement settings that define where the instances that are launched from your image will run. This parameter is required.

Returns:

this

See Also:

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

resourceTags

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder resourceTags(Map<String,String> resourceTags)

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.

Parameters:

resourceTags - The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process. This parameter is required.

Returns:

this

See Also:

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

resourceTags

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder resourceTags(IResolvable resourceTags)

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.

Parameters:

resourceTags - The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process. This parameter is required.

Returns:

this

See Also:

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

securityGroupIds

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder securityGroupIds(List<String> securityGroupIds)

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

Parameters:

securityGroupIds - The security group IDs to associate with the instance used to customize your Amazon EC2 AMI. This parameter is required.

Returns:

this

See Also:

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

snsTopicArn

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder snsTopicArn(String snsTopicArn)

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.

Parameters:

snsTopicArn - The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications. This parameter is required.

Returns:

this

See Also:

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

snsTopicArn

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder snsTopicArn(ITopicRef snsTopicArn)

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.

Parameters:

snsTopicArn - The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications. This parameter is required.

Returns:

this

See Also:

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

subnetId

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder subnetId(String subnetId)

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

Parameters:

subnetId - The subnet ID in which to place the instance used to customize your Amazon EC2 AMI. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder tags(Map<String,String> tags)

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

Tags are formatted as key value pairs.

Parameters:

tags - The metadata tags to assign to the infrastructure configuration resource that Image Builder creates as output. This parameter is required.

Returns:

this

See Also:

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

terminateInstanceOnFailure

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder terminateInstanceOnFailure(Boolean terminateInstanceOnFailure)

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.

Parameters:

terminateInstanceOnFailure - The terminate instance on failure setting of the infrastructure configuration. This parameter is required.

Returns:

this

See Also:

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

terminateInstanceOnFailure

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin.Builder terminateInstanceOnFailure(IResolvable terminateInstanceOnFailure)

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.

Parameters:

terminateInstanceOnFailure - The terminate instance on failure setting of the infrastructure configuration. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnInfrastructureConfigurationPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnInfrastructureConfigurationPropsMixin>

Returns:

a newly built instance of CfnInfrastructureConfigurationPropsMixin.