CreateEnvironmentRequest.Builder (AWS Java SDK :: Services

All Superinterfaces:

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

Enclosing class:

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`CreateEnvironmentRequest.Builder`	`codebuildRoleArn(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.
`CreateEnvironmentRequest.Builder`	`componentRoleArn(String componentRoleArn)` The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment.
`CreateEnvironmentRequest.Builder`	`description(String description)` A description of the environment that's being created and deployed.
`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.
`CreateEnvironmentRequest.Builder`	`name(String name)` The name of the environment.
`CreateEnvironmentRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`CreateEnvironmentRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`CreateEnvironmentRequest.Builder`	`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.
`CreateEnvironmentRequest.Builder`	`provisioningRepository(RepositoryBranchInput provisioningRepository)` The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning.
`CreateEnvironmentRequest.Builder`	`spec(String spec)` A YAML formatted string that provides inputs as defined in the environment template bundle schema file.
`CreateEnvironmentRequest.Builder`	`tags(Collection<Tag> tags)` An optional list of metadata items that you can associate with the Proton environment.
`CreateEnvironmentRequest.Builder`	`tags(Consumer<Tag.Builder>... tags)` An optional list of metadata items that you can associate with the Proton environment.
`CreateEnvironmentRequest.Builder`	`tags(Tag... tags)` An optional list of metadata items that you can associate with the Proton environment.
`CreateEnvironmentRequest.Builder`	`templateMajorVersion(String templateMajorVersion)` The major version of the environment template.
`CreateEnvironmentRequest.Builder`	`templateMinorVersion(String templateMinorVersion)` The minor version of the environment template.
`CreateEnvironmentRequest.Builder`	`templateName(String templateName)` The name of the environment template.

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
  - codebuildRoleArn
```
CreateEnvironmentRequest.Builder codebuildRoleArn(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.
    
    To use CodeBuild-based provisioning for the environment or for any service instance running in the environment, specify either the environmentAccountConnectionId or codebuildRoleArn 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 or codebuildRoleArn parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - componentRoleArn
```
CreateEnvironmentRequest.Builder componentRoleArn(String 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
```
CreateEnvironmentRequest.Builder description(String 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 or protonServiceRoleArn parameter and omit the provisioningRepository 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 or protonServiceRoleArn parameter and omit the provisioningRepository parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - name
```
CreateEnvironmentRequest.Builder name(String 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
```
CreateEnvironmentRequest.Builder 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.
    
    To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository 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 or protonServiceRoleArn parameter and omit the provisioningRepository 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 and protonServiceRoleArn 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 and protonServiceRoleArn 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 environmentAccountConnectionId and protonServiceRoleArn parameters.
    This is a convenience method that creates an instance of the RepositoryBranchInput.Builder avoiding the need to create one manually via RepositoryBranchInput.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to provisioningRepository(RepositoryBranchInput).
    
    Parameters:
    
    provisioningRepository - a consumer that will call methods on RepositoryBranchInput.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    provisioningRepository(RepositoryBranchInput)
  - spec
```
CreateEnvironmentRequest.Builder spec(String 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
```
CreateEnvironmentRequest.Builder tags(Collection<Tag> 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
```
CreateEnvironmentRequest.Builder tags(Tag... 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
```
CreateEnvironmentRequest.Builder tags(Consumer<Tag.Builder>... 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 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)
  - templateMajorVersion
```
CreateEnvironmentRequest.Builder templateMajorVersion(String 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
```
CreateEnvironmentRequest.Builder templateMinorVersion(String 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
```
CreateEnvironmentRequest.Builder templateName(String 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)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
CreateEnvironmentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface CreateEnvironmentRequest.Builder

Method Summary

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

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

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

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

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

Method Detail

codebuildRoleArn

componentRoleArn

description

environmentAccountConnectionId

name

protonServiceRoleArn

provisioningRepository

provisioningRepository

spec

tags

tags

tags

templateMajorVersion

templateMinorVersion

templateName

overrideConfiguration

overrideConfiguration