Interface CreateInfrastructureConfigurationRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateInfrastructureConfigurationRequest.Builder,
,CreateInfrastructureConfigurationRequest> ImagebuilderRequest.Builder
,SdkBuilder<CreateInfrastructureConfigurationRequest.Builder,
,CreateInfrastructureConfigurationRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateInfrastructureConfigurationRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(String clientToken) Unique, case-sensitive identifier you provide to ensure idempotency of the request.description
(String description) The description of the infrastructure configuration.instanceMetadataOptions
(Consumer<InstanceMetadataOptions.Builder> instanceMetadataOptions) The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.instanceMetadataOptions
(InstanceMetadataOptions instanceMetadataOptions) The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.instanceProfileName
(String instanceProfileName) The instance profile to associate with the instance used to customize your Amazon EC2 AMI.instanceTypes
(String... instanceTypes) The instance types of the infrastructure configuration.instanceTypes
(Collection<String> instanceTypes) The instance types of the infrastructure configuration.The key pair of the infrastructure configuration.logging
(Consumer<Logging.Builder> logging) The logging configuration of the infrastructure configuration.The logging configuration of the infrastructure configuration.The name of the infrastructure configuration.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.resourceTags
(Map<String, String> resourceTags) The tags attached to the resource created by Image Builder.securityGroupIds
(String... securityGroupIds) The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.securityGroupIds
(Collection<String> securityGroupIds) The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.snsTopicArn
(String snsTopicArn) The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.The tags of the infrastructure configuration.terminateInstanceOnFailure
(Boolean terminateInstanceOnFailure) The terminate instance on failure setting of the infrastructure configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.imagebuilder.model.ImagebuilderRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
The name of the infrastructure configuration.
- Parameters:
name
- The name of the infrastructure configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
The description of the infrastructure configuration.
- Parameters:
description
- The description of the infrastructure configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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. 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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. 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
securityGroupIds
CreateInfrastructureConfigurationRequest.Builder securityGroupIds(Collection<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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logging
The logging configuration of the infrastructure configuration.
- Parameters:
logging
- The logging configuration of the infrastructure configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logging
The logging configuration of the infrastructure configuration.
This is a convenience method that creates an instance of theLogging.Builder
avoiding the need to create one manually viaLogging.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tologging(Logging)
.- Parameters:
logging
- a consumer that will call methods onLogging.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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. You can use this to log on to and debug the instance used to create your image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
terminateInstanceOnFailure
CreateInfrastructureConfigurationRequest.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. 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceTags
The tags attached to the resource created by Image Builder.
- Parameters:
resourceTags
- The tags attached to the resource created by Image Builder.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceMetadataOptions
CreateInfrastructureConfigurationRequest.Builder instanceMetadataOptions(InstanceMetadataOptions 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceMetadataOptions
default CreateInfrastructureConfigurationRequest.Builder instanceMetadataOptions(Consumer<InstanceMetadataOptions.Builder> 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 is a convenience method that creates an instance of theInstanceMetadataOptions.Builder
avoiding the need to create one manually viaInstanceMetadataOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinstanceMetadataOptions(InstanceMetadataOptions)
.- Parameters:
instanceMetadataOptions
- a consumer that will call methods onInstanceMetadataOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
The tags of the infrastructure configuration.
- Parameters:
tags
- The tags of the infrastructure configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientToken
Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
- Parameters:
clientToken
- Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateInfrastructureConfigurationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateInfrastructureConfigurationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-