software.amazon.awssdk.services.proton.model

Interface CreateComponentRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateComponentRequest.Builder,CreateComponentRequest>, ProtonRequest.Builder, SdkBuilder<CreateComponentRequest.Builder,CreateComponentRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateComponentRequest

public static interface CreateComponentRequest.Builder
extends ProtonRequest.Builder, SdkPojo, CopyableBuilder<CreateComponentRequest.Builder,CreateComponentRequest>

Method Summary

Modifier and Type	Method and Description
CreateComponentRequest.Builder	clientToken(String clientToken) The client token for the created component.
CreateComponentRequest.Builder	description(String description) An optional customer-provided description of the component.
CreateComponentRequest.Builder	environmentName(String environmentName) The name of the Proton environment that you want to associate this component with.
CreateComponentRequest.Builder	manifest(String manifest) A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.
CreateComponentRequest.Builder	name(String name) The customer-provided name of the component.
CreateComponentRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateComponentRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateComponentRequest.Builder	serviceInstanceName(String serviceInstanceName) The name of the service instance that you want to attach this component to.
CreateComponentRequest.Builder	serviceName(String serviceName) The name of the service that serviceInstanceName is associated with.
CreateComponentRequest.Builder	serviceSpec(String serviceSpec) The service spec that you want the component to use to access service inputs.
CreateComponentRequest.Builder	tags(Collection<Tag> tags) An optional list of metadata items that you can associate with the Proton component.
CreateComponentRequest.Builder	tags(Consumer<Tag.Builder>... tags) An optional list of metadata items that you can associate with the Proton component.
CreateComponentRequest.Builder	tags(Tag... tags) An optional list of metadata items that you can associate with the Proton component.
CreateComponentRequest.Builder	templateFile(String templateFile) A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

Methods inherited from interface software.amazon.awssdk.services.proton.model.ProtonRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

clientToken

CreateComponentRequest.Builder clientToken(String clientToken)

The client token for the created component.

Parameters:

clientToken - The client token for the created component.

Returns:

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

description

CreateComponentRequest.Builder description(String description)

An optional customer-provided description of the component.

Parameters:

description - An optional customer-provided description of the component.

Returns:

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

environmentName

CreateComponentRequest.Builder environmentName(String environmentName)

The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify serviceInstanceName and serviceName.

Parameters:

environmentName - The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify serviceInstanceName and serviceName.

Returns:

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

manifest

CreateComponentRequest.Builder manifest(String manifest)

A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.

Parameters:

manifest - A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering engine for infrastructure that a custom component provisions.

Returns:

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

name

CreateComponentRequest.Builder name(String name)

The customer-provided name of the component.

Parameters:

name - The customer-provided name of the component.

Returns:

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

serviceInstanceName

CreateComponentRequest.Builder serviceInstanceName(String serviceInstanceName)

The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.

Parameters:

serviceInstanceName - The name of the service instance that you want to attach this component to. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.

Returns:

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

serviceName

CreateComponentRequest.Builder serviceName(String serviceName)

The name of the service that serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.

Parameters:

serviceName - The name of the service that serviceInstanceName is associated with. If you don't specify this, the component isn't attached to any service instance. Specify both serviceInstanceName and serviceName or neither of them.

Returns:

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

serviceSpec

CreateComponentRequest.Builder serviceSpec(String serviceSpec)

The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service instance.

Parameters:

serviceSpec - The service spec that you want the component to use to access service inputs. Set this only when you attach the component to a service instance.

Returns:

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

tags

CreateComponentRequest.Builder tags(Collection<Tag> tags)

An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton User Guide.

Parameters:

tags - An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton User Guide.

Returns:

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

tags

CreateComponentRequest.Builder tags(Tag... tags)

An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton User Guide.

Parameters:

tags - An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton User Guide.

Returns:

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

tags

CreateComponentRequest.Builder tags(Consumer<Tag.Builder>... tags)

An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton User Guide.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

templateFile

CreateComponentRequest.Builder templateFile(String templateFile)

A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

Components support a single IaC file, even if you use Terraform as your template language.

Parameters:

templateFile - A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.

Components support a single IaC file, even if you use Terraform as your template language.

Returns:

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

overrideConfiguration

CreateComponentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateComponentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder