CreateEnvironmentRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.proton.model.CreateEnvironmentRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateEnvironmentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateEnvironmentRequest()

Constructors
Constructor and Description
`CreateEnvironmentRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
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`	`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 infrastructure 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`	`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 infrastructure 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`	`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 infrastructure 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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateEnvironmentRequest
```
public CreateEnvironmentRequest()
```
- Method Detail
  - setComponentRoleArn
```
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 Administrator 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 Administrator Guide.
  - getComponentRoleArn
```
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 Administrator Guide.
    
    Returns:
    
    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 Administrator Guide.
  - withComponentRoleArn
```
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 Administrator 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 Administrator Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(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.
  - getDescription
```
public String getDescription()
```
    A description of the environment that's being created and deployed.
    
    Returns:
    
    A description of the environment that's being created and deployed.
  - withDescription
```
public CreateEnvironmentRequest withDescription(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.
  - setEnvironmentAccountConnectionId
```
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 Administrator 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 Administrator guide.
    
    To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.
  - getEnvironmentAccountConnectionId
```
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 Administrator guide.
    
    To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.
    
    Returns:
    
    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 Administrator guide.
    
    To use Amazon Web Services-managed provisioning for the environment, specify either the environmentAccountConnectionId or protonServiceRoleArn parameter and omit the provisioningRepository parameter.
  - withEnvironmentAccountConnectionId
```
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 Administrator 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 Administrator 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.
  - setName
```
public void setName(String name)
```
    The name of the environment.
    
    Parameters:
    
    name - The name of the environment.
  - getName
```
public String getName()
```
    The name of the environment.
    
    Returns:
    
    The name of the environment.
  - withName
```
public CreateEnvironmentRequest withName(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.
  - setProtonServiceRoleArn
```
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.
    
    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.
  - getProtonServiceRoleArn
```
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.
    
    Returns:
    
    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.
  - withProtonServiceRoleArn
```
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.
    
    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.
  - setProvisioningRepository
```
public void setProvisioningRepository(RepositoryBranchInput provisioningRepository)
```
    The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
    
    To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.
    
    Parameters:
    
    provisioningRepository - The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
    
    To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.
  - getProvisioningRepository
```
public RepositoryBranchInput getProvisioningRepository()
```
    The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
    
    To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.
    
    Returns:
    
    The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
    
    To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.
  - withProvisioningRepository
```
public CreateEnvironmentRequest withProvisioningRepository(RepositoryBranchInput provisioningRepository)
```
    The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
    
    To use self-managed provisioning for the environment, specify this parameter and omit the environmentAccountConnectionId and protonServiceRoleArn parameters.
    
    Parameters:
    
    provisioningRepository - The infrastructure repository that you use to host your rendered infrastructure templates for self-managed provisioning.
    
    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.
  - setSpec
```
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 Administrator 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 Administrator Guide.
  - getSpec
```
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 Administrator Guide.
    
    Returns:
    
    A YAML formatted string that provides inputs as defined in the environment template bundle schema file. For more information, see Environments in the Proton Administrator Guide.
  - withSpec
```
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 Administrator 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 Administrator Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
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 Administrator Guide or Proton User Guide.
    
    Returns:
    
    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 Administrator Guide or Proton User Guide.
  - setTags
```
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 Administrator Guide or 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 Administrator Guide or Proton User Guide.
  - withTags
```
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 Administrator Guide or 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.
    
    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 Administrator Guide or Proton User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
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 Administrator Guide or 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 Administrator Guide or Proton User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateMajorVersion
```
public void setTemplateMajorVersion(String templateMajorVersion)
```
    The major version of the environment template.
    
    Parameters:
    
    templateMajorVersion - The major version of the environment template.
  - getTemplateMajorVersion
```
public String getTemplateMajorVersion()
```
    The major version of the environment template.
    
    Returns:
    
    The major version of the environment template.
  - withTemplateMajorVersion
```
public CreateEnvironmentRequest withTemplateMajorVersion(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.
  - setTemplateMinorVersion
```
public void setTemplateMinorVersion(String templateMinorVersion)
```
    The minor version of the environment template.
    
    Parameters:
    
    templateMinorVersion - The minor version of the environment template.
  - getTemplateMinorVersion
```
public String getTemplateMinorVersion()
```
    The minor version of the environment template.
    
    Returns:
    
    The minor version of the environment template.
  - withTemplateMinorVersion
```
public CreateEnvironmentRequest withTemplateMinorVersion(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.
  - setTemplateName
```
public void setTemplateName(String templateName)
```
    The name of the environment template. For more information, see Environment Templates in the Proton Administrator Guide.
    
    Parameters:
    
    templateName - The name of the environment template. For more information, see Environment Templates in the Proton Administrator Guide.
  - getTemplateName
```
public String getTemplateName()
```
    The name of the environment template. For more information, see Environment Templates in the Proton Administrator Guide.
    
    Returns:
    
    The name of the environment template. For more information, see Environment Templates in the Proton Administrator Guide.
  - withTemplateName
```
public CreateEnvironmentRequest withTemplateName(String templateName)
```
    The name of the environment template. For more information, see Environment Templates in the Proton Administrator Guide.
    
    Parameters:
    
    templateName - The name of the environment template. For more information, see Environment Templates in the Proton Administrator Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateEnvironmentRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class CreateEnvironmentRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateEnvironmentRequest

Method Detail

setComponentRoleArn

getComponentRoleArn

withComponentRoleArn

setDescription

getDescription

withDescription

setEnvironmentAccountConnectionId

getEnvironmentAccountConnectionId

withEnvironmentAccountConnectionId

setName

getName

withName

setProtonServiceRoleArn

getProtonServiceRoleArn

withProtonServiceRoleArn

setProvisioningRepository

getProvisioningRepository

withProvisioningRepository

setSpec

getSpec

withSpec

getTags

setTags

withTags

withTags

setTemplateMajorVersion

getTemplateMajorVersion

withTemplateMajorVersion

setTemplateMinorVersion

getTemplateMinorVersion

withTemplateMinorVersion

setTemplateName

getTemplateName

withTemplateName

toString

equals

hashCode

clone