@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateEnvironmentRequest() |
Modifier and Type | Method and Description |
---|---|
CreateEnvironmentRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getCodebuildRoleArn()
The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using
CodeBuild-based provisioning on your behalf.
|
String |
getComponentRoleArn()
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined
components in this environment.
|
String |
getDescription()
A description of the environment that's being created and deployed.
|
String |
getEnvironmentAccountConnectionId()
The ID of the environment account connection that you provide if you're provisioning your environment
infrastructure resources to an environment account.
|
String |
getName()
The name of the environment.
|
String |
getProtonServiceRoleArn()
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on
your behalf.
|
RepositoryBranchInput |
getProvisioningRepository()
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning.
|
String |
getSpec()
A YAML formatted string that provides inputs as defined in the environment template bundle schema file.
|
List<Tag> |
getTags()
An optional list of metadata items that you can associate with the Proton environment.
|
String |
getTemplateMajorVersion()
The major version of the environment template.
|
String |
getTemplateMinorVersion()
The minor version of the environment template.
|
String |
getTemplateName()
The name of the environment template.
|
int |
hashCode() |
void |
setCodebuildRoleArn(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.
|
void |
setComponentRoleArn(String componentRoleArn)
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined
components in this environment.
|
void |
setDescription(String description)
A description of the environment that's being created and deployed.
|
void |
setEnvironmentAccountConnectionId(String environmentAccountConnectionId)
The ID of the environment account connection that you provide if you're provisioning your environment
infrastructure resources to an environment account.
|
void |
setName(String name)
The name of the environment.
|
void |
setProtonServiceRoleArn(String protonServiceRoleArn)
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on
your behalf.
|
void |
setProvisioningRepository(RepositoryBranchInput provisioningRepository)
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning.
|
void |
setSpec(String spec)
A YAML formatted string that provides inputs as defined in the environment template bundle schema file.
|
void |
setTags(Collection<Tag> tags)
An optional list of metadata items that you can associate with the Proton environment.
|
void |
setTemplateMajorVersion(String templateMajorVersion)
The major version of the environment template.
|
void |
setTemplateMinorVersion(String templateMinorVersion)
The minor version of the environment template.
|
void |
setTemplateName(String templateName)
The name of the environment template.
|
String |
toString()
Returns a string representation of this object.
|
CreateEnvironmentRequest |
withCodebuildRoleArn(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 |
withComponentRoleArn(String componentRoleArn)
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined
components in this environment.
|
CreateEnvironmentRequest |
withDescription(String description)
A description of the environment that's being created and deployed.
|
CreateEnvironmentRequest |
withEnvironmentAccountConnectionId(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 |
withName(String name)
The name of the environment.
|
CreateEnvironmentRequest |
withProtonServiceRoleArn(String protonServiceRoleArn)
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on
your behalf.
|
CreateEnvironmentRequest |
withProvisioningRepository(RepositoryBranchInput provisioningRepository)
The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning.
|
CreateEnvironmentRequest |
withSpec(String spec)
A YAML formatted string that provides inputs as defined in the environment template bundle schema file.
|
CreateEnvironmentRequest |
withTags(Collection<Tag> tags)
An optional list of metadata items that you can associate with the Proton environment.
|
CreateEnvironmentRequest |
withTags(Tag... tags)
An optional list of metadata items that you can associate with the Proton environment.
|
CreateEnvironmentRequest |
withTemplateMajorVersion(String templateMajorVersion)
The major version of the environment template.
|
CreateEnvironmentRequest |
withTemplateMinorVersion(String templateMinorVersion)
The minor version of the environment template.
|
CreateEnvironmentRequest |
withTemplateName(String templateName)
The name of the environment template.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setCodebuildRoleArn(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.
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.
public String getCodebuildRoleArn()
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.
To use CodeBuild-based provisioning for the environment or for any service instance running in the
environment, specify either the environmentAccountConnectionId
or
codebuildRoleArn
parameter.
public CreateEnvironmentRequest withCodebuildRoleArn(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.
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.
public void setComponentRoleArn(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.
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.
public String getComponentRoleArn()
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.
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.
public CreateEnvironmentRequest withComponentRoleArn(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.
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.
public void setDescription(String description)
A description of the environment that's being created and deployed.
description
- A description of the environment that's being created and deployed.public String getDescription()
A description of the environment that's being created and deployed.
public CreateEnvironmentRequest withDescription(String description)
A description of the environment that's being created and deployed.
description
- A description of the environment that's being created and deployed.public void setEnvironmentAccountConnectionId(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.
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.
public String getEnvironmentAccountConnectionId()
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.
To use Amazon Web Services-managed provisioning for the environment, specify either the
environmentAccountConnectionId
or protonServiceRoleArn
parameter and omit the
provisioningRepository
parameter.
public CreateEnvironmentRequest withEnvironmentAccountConnectionId(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.
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.
public void setName(String name)
The name of the environment.
name
- The name of the environment.public String getName()
The name of the environment.
public CreateEnvironmentRequest withName(String name)
The name of the environment.
name
- The name of the environment.public void setProtonServiceRoleArn(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.
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.
public String getProtonServiceRoleArn()
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.
To use Amazon Web Services-managed provisioning for the environment, specify either the
environmentAccountConnectionId
or protonServiceRoleArn
parameter and omit the
provisioningRepository
parameter.
public CreateEnvironmentRequest withProtonServiceRoleArn(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.
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.
public void setProvisioningRepository(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.
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.
public RepositoryBranchInput getProvisioningRepository()
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.
To use self-managed provisioning for the environment, specify this parameter and omit the
environmentAccountConnectionId
and protonServiceRoleArn
parameters.
public CreateEnvironmentRequest withProvisioningRepository(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.
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.
public void setSpec(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.
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.public String getSpec()
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.
public CreateEnvironmentRequest withSpec(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.
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.public List<Tag> getTags()
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.
For more information, see Proton resources and tagging in the Proton User Guide.
public void setTags(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.
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.
public CreateEnvironmentRequest withTags(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.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
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.
public CreateEnvironmentRequest withTags(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.
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.
public void setTemplateMajorVersion(String templateMajorVersion)
The major version of the environment template.
templateMajorVersion
- The major version of the environment template.public String getTemplateMajorVersion()
The major version of the environment template.
public CreateEnvironmentRequest withTemplateMajorVersion(String templateMajorVersion)
The major version of the environment template.
templateMajorVersion
- The major version of the environment template.public void setTemplateMinorVersion(String templateMinorVersion)
The minor version of the environment template.
templateMinorVersion
- The minor version of the environment template.public String getTemplateMinorVersion()
The minor version of the environment template.
public CreateEnvironmentRequest withTemplateMinorVersion(String templateMinorVersion)
The minor version of the environment template.
templateMinorVersion
- The minor version of the environment template.public void setTemplateName(String templateName)
The name of the environment template. For more information, see Environment Templates in the Proton User Guide.
templateName
- The name of the environment template. For more information, see Environment Templates in
the Proton User Guide.public String getTemplateName()
The name of the environment template. For more information, see Environment Templates in the Proton User Guide.
public CreateEnvironmentRequest withTemplateName(String templateName)
The name of the environment template. For more information, see Environment Templates in the Proton User Guide.
templateName
- The name of the environment template. For more information, see Environment Templates in
the Proton User Guide.public String toString()
toString
in class Object
Object.toString()
public CreateEnvironmentRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()