Interface CreateEnvironmentRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateEnvironmentRequest.Builder,
,CreateEnvironmentRequest> ProtonRequest.Builder
,SdkBuilder<CreateEnvironmentRequest.Builder,
,CreateEnvironmentRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateEnvironmentRequest
-
Method Summary
Modifier and TypeMethodDescriptioncodebuildRoleArn
(String codebuildRoleArn) The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.componentRoleArn
(String componentRoleArn) The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment.description
(String description) A description of the environment that's being created and deployed.environmentAccountConnectionId
(String environmentAccountConnectionId) The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account.The name of the environment.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.protonServiceRoleArn
(String protonServiceRoleArn) The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.default CreateEnvironmentRequest.Builder
provisioningRepository
(Consumer<RepositoryBranchInput.Builder> provisioningRepository) The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning.provisioningRepository
(RepositoryBranchInput provisioningRepository) The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning.A YAML formatted string that provides inputs as defined in the environment template bundle schema file.tags
(Collection<Tag> tags) An optional list of metadata items that you can associate with the Proton environment.tags
(Consumer<Tag.Builder>... tags) An optional list of metadata items that you can associate with the Proton environment.An optional list of metadata items that you can associate with the Proton environment.templateMajorVersion
(String templateMajorVersion) The major version of the environment template.templateMinorVersion
(String templateMinorVersion) The minor version of the environment template.templateName
(String templateName) The name of the environment template.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
-
codebuildRoleArn
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the
environmentAccountConnectionId
orcodebuildRoleArn
parameter.- Parameters:
codebuildRoleArn
- The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the
environmentAccountConnectionId
orcodebuildRoleArn
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
componentRoleArn
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.
You must specify
componentRoleArn
to allow directly defined components to be associated with this environment.For more information about components, see Proton components in the Proton User Guide.
- Parameters:
componentRoleArn
- The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment. It determines the scope of infrastructure that a component can provision.You must specify
componentRoleArn
to allow directly defined components to be associated with this environment.For more information about components, see Proton components in the Proton User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
A description of the environment that's being created and deployed.
- Parameters:
description
- A description of the environment that's being created and deployed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
environmentAccountConnectionId
CreateEnvironmentRequest.Builder environmentAccountConnectionId(String environmentAccountConnectionId) The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. For more information, see Environment account connections in the Proton User guide.
To use Amazon Web Services-managed provisioning for the environment, specify either the
environmentAccountConnectionId
orprotonServiceRoleArn
parameter and omit theprovisioningRepository
parameter.- Parameters:
environmentAccountConnectionId
- The ID of the environment account connection that you provide if you're provisioning your environment infrastructure resources to an environment account. For more information, see Environment account connections in the Proton User guide.To use Amazon Web Services-managed provisioning for the environment, specify either the
environmentAccountConnectionId
orprotonServiceRoleArn
parameter and omit theprovisioningRepository
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The name of the environment.
- Parameters:
name
- The name of the environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
protonServiceRoleArn
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
To use Amazon Web Services-managed provisioning for the environment, specify either the
environmentAccountConnectionId
orprotonServiceRoleArn
parameter and omit theprovisioningRepository
parameter.- Parameters:
protonServiceRoleArn
- The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.To use Amazon Web Services-managed provisioning for the environment, specify either the
environmentAccountConnectionId
orprotonServiceRoleArn
parameter and omit theprovisioningRepository
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
provisioningRepository
CreateEnvironmentRequest.Builder provisioningRepository(RepositoryBranchInput provisioningRepository) The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
To use self-managed provisioning for the environment, specify this parameter and omit the
environmentAccountConnectionId
andprotonServiceRoleArn
parameters.- Parameters:
provisioningRepository
- The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.To use self-managed provisioning for the environment, specify this parameter and omit the
environmentAccountConnectionId
andprotonServiceRoleArn
parameters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
provisioningRepository
default CreateEnvironmentRequest.Builder provisioningRepository(Consumer<RepositoryBranchInput.Builder> provisioningRepository) The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning. A linked repository is a repository that has been registered with Proton. For more information, see CreateRepository.
To use self-managed provisioning for the environment, specify this parameter and omit the
This is a convenience method that creates an instance of theenvironmentAccountConnectionId
andprotonServiceRoleArn
parameters.RepositoryBranchInput.Builder
avoiding the need to create one manually viaRepositoryBranchInput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprovisioningRepository(RepositoryBranchInput)
.- Parameters:
provisioningRepository
- a consumer that will call methods onRepositoryBranchInput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
spec
A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton User Guide.
- Parameters:
spec
- A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments 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 environment. 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 environment. 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 environment. 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 environment. 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 environment. 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:
-
templateMajorVersion
The major version of the environment template.
- Parameters:
templateMajorVersion
- The major version of the environment template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
templateMinorVersion
The minor version of the environment template.
- Parameters:
templateMinorVersion
- The minor version of the environment template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
templateName
The name of the environment template. For more information, see Environment Templates in the Proton User Guide.
- Parameters:
templateName
- The name of the environment template. For more information, see Environment Templates in the Proton User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateEnvironmentRequest.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
CreateEnvironmentRequest.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.
-