Interface CreateComponentRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateComponentRequest.Builder,
,CreateComponentRequest> ProtonRequest.Builder
,SdkBuilder<CreateComponentRequest.Builder,
,CreateComponentRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateComponentRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(String clientToken) The client token for the created component.description
(String description) An optional customer-provided description of the component.environmentName
(String environmentName) The name of the Proton environment that you want to associate this component with.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.The customer-provided name of the component.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.serviceInstanceName
(String serviceInstanceName) The name of the service instance that you want to attach this component to.serviceName
(String serviceName) The name of the service thatserviceInstanceName
is associated with.serviceSpec
(String serviceSpec) The service spec that you want the component to use to access service inputs.tags
(Collection<Tag> tags) An optional list of metadata items that you can associate with the Proton component.tags
(Consumer<Tag.Builder>... tags) An optional list of metadata items that you can associate with the Proton component.An optional list of metadata items that you can associate with the Proton component.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.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.proton.model.ProtonRequest.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
-
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
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
The name of the Proton environment that you want to associate this component with. You must specify this when you don't specify
serviceInstanceName
andserviceName
.- Parameters:
environmentName
- The name of the Proton environment that you want to associate this component with. You must specify this when you don't specifyserviceInstanceName
andserviceName
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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
andserviceName
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 bothserviceInstanceName
andserviceName
or neither of them.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 bothserviceInstanceName
andserviceName
or neither of them.- Parameters:
serviceName
- The name of the service thatserviceInstanceName
is associated with. If you don't specify this, the component isn't attached to any service instance. Specify bothserviceInstanceName
andserviceName
or neither of them.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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
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 theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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) 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
CreateComponentRequest.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.
-