Package software.amazon.awssdk.services.imagebuilder.model

Interface CreateComponentRequest.Builder

    • Method Detail

      • name

        CreateComponentRequest.Builder name​(String name)

        The name of the component.

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

      • semanticVersion

        CreateComponentRequest.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, with an upper limit of 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, with an upper limit of 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

        CreateComponentRequest.Builder description​(String description)

        Describes the contents of the component.

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

      • changeDescription

        CreateComponentRequest.Builder changeDescription​(String changeDescription)

        The change description of the component. Describes what change 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. Describes what change 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.

      • platform

        CreateComponentRequest.Builder platform​(String platform)

        The operating system platform of the component.

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

      • platform

        CreateComponentRequest.Builder platform​(Platform platform)

        The operating system platform of the component.

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

      • supportedOsVersions

        CreateComponentRequest.Builder supportedOsVersions​(Collection<String> supportedOsVersions)

        The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

        Parameters:
        supportedOsVersions - The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • supportedOsVersions

        CreateComponentRequest.Builder supportedOsVersions​(String... supportedOsVersions)

        The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

        Parameters:
        supportedOsVersions - The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • data

        CreateComponentRequest.Builder data​(String data)

        Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.

        Parameters:
        data - Component data contains inline YAML document content for the component. Alternatively, you can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • uri

        CreateComponentRequest.Builder uri​(String uri)

        The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key ), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

        Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

        Parameters:
        uri - The uri of a YAML component document file. This must be an S3 URL ( s3://bucket/key), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.

        Alternatively, you can specify the YAML document inline, using the component data property. You cannot specify both properties.

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

      • kmsKeyId

        CreateComponentRequest.Builder kmsKeyId​(String kmsKeyId)

        The ID of the KMS key that is used to encrypt this component.

        Parameters:
        kmsKeyId - The ID of the KMS key that is used to encrypt this component.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateComponentRequest.Builder tags​(Map<String,​String> tags)

        The tags that apply to the component.

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

      • clientToken

        CreateComponentRequest.Builder clientToken​(String 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.