Interface CreateInfrastructureConfigurationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateInfrastructureConfigurationRequest.Builder,CreateInfrastructureConfigurationRequest>, ImagebuilderRequest.Builder, SdkBuilder<CreateInfrastructureConfigurationRequest.Builder,CreateInfrastructureConfigurationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateInfrastructureConfigurationRequest
@Mutable @NotThreadSafe public static interface CreateInfrastructureConfigurationRequest.Builder extends ImagebuilderRequest.Builder, SdkPojo, CopyableBuilder<CreateInfrastructureConfigurationRequest.Builder,CreateInfrastructureConfigurationRequest>

  • Method Details

    • name

      CreateInfrastructureConfigurationRequest.Builder name(String name)

      The name of the infrastructure configuration. Infrastructure configuration names must be unique to your account in each Amazon Web Services Region. Image Builder generates the infrastructure configuration ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name.

      Parameters:
      name - The name of the infrastructure configuration. Infrastructure configuration names must be unique to your account in each Amazon Web Services Region. Image Builder generates the infrastructure configuration ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateInfrastructureConfigurationRequest.Builder description(String 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

      CreateInfrastructureConfigurationRequest.Builder instanceTypes(Collection<String> instanceTypes)

      The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. Image Builder picks one of these instance types based on availability. If you don't specify instance types, Image Builder selects compatible instance types automatically. If you specify a Dedicated Host, Image Builder uses only instance types that the host supports.

      Parameters:
      instanceTypes - The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. Image Builder picks one of these instance types based on availability. If you don't specify instance types, Image Builder selects compatible instance types automatically. If you specify a Dedicated Host, Image Builder uses only instance types that the host supports.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceTypes

      CreateInfrastructureConfigurationRequest.Builder instanceTypes(String... instanceTypes)

      The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. Image Builder picks one of these instance types based on availability. If you don't specify instance types, Image Builder selects compatible instance types automatically. If you specify a Dedicated Host, Image Builder uses only instance types that the host supports.

      Parameters:
      instanceTypes - The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. Image Builder picks one of these instance types based on availability. If you don't specify instance types, Image Builder selects compatible instance types automatically. If you specify a Dedicated Host, Image Builder uses only instance types that the host supports.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceProfileName

      CreateInfrastructureConfigurationRequest.Builder instanceProfileName(String instanceProfileName)

      The instance profile to associate with the instance used to customize your Amazon EC2 AMI. The instance profile must exist in your account.

      Parameters:
      instanceProfileName - The instance profile to associate with the instance used to customize your Amazon EC2 AMI. The instance profile must exist in your account.
      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

      CreateInfrastructureConfigurationRequest.Builder securityGroupIds(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.

    • subnetId

      CreateInfrastructureConfigurationRequest.Builder subnetId(String subnetId)

      The subnet ID in which to place the instance used to customize your Amazon EC2 AMI. If you specify subnetId, you must also specify one or more security group IDs in securityGroupIds. Otherwise, the request fails.

      Parameters:
      subnetId - The subnet ID in which to place the instance used to customize your Amazon EC2 AMI. If you specify subnetId, you must also specify one or more security group IDs in securityGroupIds. Otherwise, the request fails.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logging

      CreateInfrastructureConfigurationRequest.Builder logging(Logging logging)

      The logging configuration of the infrastructure configuration. When you configure S3 logs, Image Builder writes logs from the build and test process to the specified bucket under the key prefix.

      Parameters:
      logging - The logging configuration of the infrastructure configuration. When you configure S3 logs, Image Builder writes logs from the build and test process to the specified bucket under the key prefix.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logging

      default CreateInfrastructureConfigurationRequest.Builder logging(Consumer<Logging.Builder> logging)

      The logging configuration of the infrastructure configuration. When you configure S3 logs, Image Builder writes logs from the build and test process to the specified bucket under the key prefix.

      This is a convenience method that creates an instance of the Logging.Builder avoiding the need to create one manually via Logging.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to logging(Logging).

      Parameters:
      logging - a consumer that will call methods on Logging.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • keyPair

      CreateInfrastructureConfigurationRequest.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. 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)

      Specifies whether to terminate the instance on failure. 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. Defaults to true.

      Parameters:
      terminateInstanceOnFailure - Specifies whether to terminate the instance on failure. 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. Defaults to true.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • snsTopicArn

      CreateInfrastructureConfigurationRequest.Builder snsTopicArn(String snsTopicArn)

      The Amazon Resource Name (ARN) of the SNS topic to which Image Builder sends image build event notifications. Specify a standard topic. Image Builder doesn't support FIFO topics. Image Builder validates the topic when you create or update the configuration. You must have permission to publish to the topic.

      EC2 Image Builder can't send notifications to SNS topics that are encrypted using keys from other accounts. If your SNS topic is encrypted, the key must be owned by the same account that owns your Image Builder resources.

      Parameters:
      snsTopicArn - The Amazon Resource Name (ARN) of the SNS topic to which Image Builder sends image build event notifications. Specify a standard topic. Image Builder doesn't support FIFO topics. Image Builder validates the topic when you create or update the configuration. You must have permission to publish to the topic.

      EC2 Image Builder can't send notifications to SNS topics that are encrypted using keys from other accounts. If your SNS topic is encrypted, the key must be owned by the same account that owns your Image Builder resources.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceTags

      CreateInfrastructureConfigurationRequest.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. Tag keys can't begin with aws: or match one of the following reserved keys: CreatedBy, Ec2ImageBuilderArn, Name, or Tags.

      Parameters:
      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. Tag keys can't begin with aws: or match one of the following reserved keys: CreatedBy, Ec2ImageBuilderArn, Name, or Tags.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceMetadataOptions

      CreateInfrastructureConfigurationRequest.Builder instanceMetadataOptions(InstanceMetadataOptions instanceMetadataOptions)

      The instance metadata service (IMDS) settings that Image Builder applies to the EC2 build and test instances it launches during image creation. If you don't set these options, the EC2 launch defaults for the instance apply. For more information about instance metadata options, see one of the following links:

      Parameters:
      instanceMetadataOptions - The instance metadata service (IMDS) settings that Image Builder applies to the EC2 build and test instances it launches during image creation. If you don't set these options, the EC2 launch defaults for the instance apply. For more information about instance metadata options, see one of the following links:

      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 service (IMDS) settings that Image Builder applies to the EC2 build and test instances it launches during image creation. If you don't set these options, the EC2 launch defaults for the instance apply. For more information about instance metadata options, see one of the following links:

      This is a convenience method that creates an instance of the InstanceMetadataOptions.Builder avoiding the need to create one manually via InstanceMetadataOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceMetadataOptions(InstanceMetadataOptions).

      Parameters:
      instanceMetadataOptions - a consumer that will call methods on InstanceMetadataOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateInfrastructureConfigurationRequest.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. Tags are formatted as key value pairs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placement

      CreateInfrastructureConfigurationRequest.Builder placement(Placement placement)

      The instance placement settings that define where the build and test instances that Image Builder launches during image creation run. These settings don't affect instances that you launch from the output image.

      Parameters:
      placement - The instance placement settings that define where the build and test instances that Image Builder launches during image creation run. These settings don't affect instances that you launch from the output image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placement

      default CreateInfrastructureConfigurationRequest.Builder placement(Consumer<Placement.Builder> placement)

      The instance placement settings that define where the build and test instances that Image Builder launches during image creation run. These settings don't affect instances that you launch from the output image.

      This is a convenience method that creates an instance of the Placement.Builder avoiding the need to create one manually via Placement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to placement(Placement).

      Parameters:
      placement - a consumer that will call methods on Placement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      CreateInfrastructureConfigurationRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      Parameters:
      clientToken - A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. 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.

    • dryRun

      CreateInfrastructureConfigurationRequest.Builder dryRun(Boolean dryRun)

      Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

      Parameters:
      dryRun - Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.
      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 interface AwsRequest.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 interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.