Interface ImportComponentRequest.Builder

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

  • Method Details

    • name

      ImportComponentRequest.Builder name(String name)

      The name of the component. Image Builder generates the component ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. If a component with the same name and semantic version already exists in your account in the same Amazon Web Services Region, the request creates a new build version for it. If the content is also identical to the latest build version, the request fails because the component already exists.

      Parameters:
      name - The name of the component. Image Builder generates the component ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name. If a component with the same name and semantic version already exists in your account in the same Amazon Web Services Region, the request creates a new build version for it. If the content is also identical to the latest build version, the request fails because the component already exists.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • semanticVersion

      ImportComponentRequest.Builder semanticVersion(String semanticVersion)

      The semantic version of the component. This version follows the semantic version syntax.

      The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

      Assignment: For the first three nodes, you can assign any positive integer value, including zero. The upper limit is 2^30-1, or 1073741823, for each node. Image Builder automatically assigns the build number to the fourth node.

      Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

      Parameters:
      semanticVersion - The semantic version of the component. This version follows the semantic version syntax.

      The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

      Assignment: For the first three nodes, you can assign any positive integer value, including zero. The upper limit is 2^30-1, or 1073741823, for each node. Image Builder automatically assigns the build number to the fourth node.

      Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

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

    • description

      ImportComponentRequest.Builder description(String description)

      The description of the component. Describes the contents of the component.

      Parameters:
      description - The description of the component. Describes the contents of the component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • changeDescription

      ImportComponentRequest.Builder changeDescription(String changeDescription)

      The change description of the component. This description indicates the change that has been made in this version, or what makes this version different from other versions of the component.

      Parameters:
      changeDescription - The change description of the component. This description indicates the change that has been made in this version, or what makes this version different from other versions of the component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      ImportComponentRequest.Builder type(String type)

      The type of the component denotes whether the component is used to build the image, or only to test it.

      Parameters:
      type - The type of the component denotes whether the component is used to build the image, or only to test it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      ImportComponentRequest.Builder type(ComponentType type)

      The type of the component denotes whether the component is used to build the image, or only to test it.

      Parameters:
      type - The type of the component denotes whether the component is used to build the image, or only to test it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • format

      ImportComponentRequest.Builder format(String format)

      The format of the resource that you want to import as a component.

      Parameters:
      format - The format of the resource that you want to import as a component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • format

      ImportComponentRequest.Builder format(ComponentFormat format)

      The format of the resource that you want to import as a component.

      Parameters:
      format - The format of the resource that you want to import as a component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • platform

      ImportComponentRequest.Builder platform(String platform)

      The platform of the component.

      Parameters:
      platform - The platform of the component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • platform

      ImportComponentRequest.Builder platform(Platform platform)

      The platform of the component.

      Parameters:
      platform - The platform of the component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • data

      ImportComponentRequest.Builder data(String data)

      The data of the component. For the SHELL format, this is the plain script content. You must specify exactly one of the data or uri properties. For scripts that exceed the inline length constraint, use the uri property.

      Parameters:
      data - The data of the component. For the SHELL format, this is the plain script content. You must specify exactly one of the data or uri properties. For scripts that exceed the inline length constraint, use the uri property.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • uri

      ImportComponentRequest.Builder uri(String uri)

      The uri of the component. Must be an Amazon S3 URL and you must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

      Parameters:
      uri - The uri of the component. Must be an Amazon S3 URL and you must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      ImportComponentRequest.Builder kmsKeyId(String kmsKeyId)

      The Amazon Resource Name (ARN) of the KMS key that is used to encrypt this component. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide. If you don't specify a key, Image Builder encrypts the component data with a KMS key that Image Builder owns.

      Parameters:
      kmsKeyId - The Amazon Resource Name (ARN) of the KMS key that is used to encrypt this component. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide. If you don't specify a key, Image Builder encrypts the component data with a KMS key that Image Builder owns.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      ImportComponentRequest.Builder tags(Map<String,String> tags)

      The tags of the component.

      Parameters:
      tags - The tags of the component.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      ImportComponentRequest.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.

    • overrideConfiguration

      ImportComponentRequest.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

      ImportComponentRequest.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.