Environment (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.proton.model.Environment

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Environment
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The environment detail data. An AWS Proton environment is a set resources shared across an AWS Proton service.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Environment()

Constructors
Constructor and Description
`Environment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Environment`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the environment.
`Date`	`getCreatedAt()` The time when the environment was created.
`String`	`getDeploymentStatus()` The environment deployment status.
`String`	`getDeploymentStatusMessage()` An environment deployment status message.
`String`	`getDescription()` The description of the environment.
`String`	`getEnvironmentAccountConnectionId()` The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
`String`	`getEnvironmentAccountId()` The ID of the environment account that the environment infrastructure resources are provisioned in.
`Date`	`getLastDeploymentAttemptedAt()` The time when a deployment of the environment was last attempted.
`Date`	`getLastDeploymentSucceededAt()` The time when the environment was last deployed successfully.
`String`	`getName()` The name of the environment.
`String`	`getProtonServiceRoleArn()` The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf.
`String`	`getProvisioning()` When included, indicates that the environment template is for customer provisioned and managed infrastructure.
`String`	`getSpec()` The environment spec.
`String`	`getTemplateMajorVersion()` The ID of the major version of the environment template.
`String`	`getTemplateMinorVersion()` The ID of the minor version of the environment template.
`String`	`getTemplateName()` The Amazon Resource Name (ARN) of the environment template.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the environment.
`void`	`setCreatedAt(Date createdAt)` The time when the environment was created.
`void`	`setDeploymentStatus(String deploymentStatus)` The environment deployment status.
`void`	`setDeploymentStatusMessage(String deploymentStatusMessage)` An environment deployment status message.
`void`	`setDescription(String description)` The description of the environment.
`void`	`setEnvironmentAccountConnectionId(String environmentAccountConnectionId)` The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
`void`	`setEnvironmentAccountId(String environmentAccountId)` The ID of the environment account that the environment infrastructure resources are provisioned in.
`void`	`setLastDeploymentAttemptedAt(Date lastDeploymentAttemptedAt)` The time when a deployment of the environment was last attempted.
`void`	`setLastDeploymentSucceededAt(Date lastDeploymentSucceededAt)` The time when the environment was last deployed successfully.
`void`	`setName(String name)` The name of the environment.
`void`	`setProtonServiceRoleArn(String protonServiceRoleArn)` The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf.
`void`	`setProvisioning(String provisioning)` When included, indicates that the environment template is for customer provisioned and managed infrastructure.
`void`	`setSpec(String spec)` The environment spec.
`void`	`setTemplateMajorVersion(String templateMajorVersion)` The ID of the major version of the environment template.
`void`	`setTemplateMinorVersion(String templateMinorVersion)` The ID of the minor version of the environment template.
`void`	`setTemplateName(String templateName)` The Amazon Resource Name (ARN) of the environment template.
`String`	`toString()` Returns a string representation of this object.
`Environment`	`withArn(String arn)` The Amazon Resource Name (ARN) of the environment.
`Environment`	`withCreatedAt(Date createdAt)` The time when the environment was created.
`Environment`	`withDeploymentStatus(DeploymentStatus deploymentStatus)` The environment deployment status.
`Environment`	`withDeploymentStatus(String deploymentStatus)` The environment deployment status.
`Environment`	`withDeploymentStatusMessage(String deploymentStatusMessage)` An environment deployment status message.
`Environment`	`withDescription(String description)` The description of the environment.
`Environment`	`withEnvironmentAccountConnectionId(String environmentAccountConnectionId)` The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
`Environment`	`withEnvironmentAccountId(String environmentAccountId)` The ID of the environment account that the environment infrastructure resources are provisioned in.
`Environment`	`withLastDeploymentAttemptedAt(Date lastDeploymentAttemptedAt)` The time when a deployment of the environment was last attempted.
`Environment`	`withLastDeploymentSucceededAt(Date lastDeploymentSucceededAt)` The time when the environment was last deployed successfully.
`Environment`	`withName(String name)` The name of the environment.
`Environment`	`withProtonServiceRoleArn(String protonServiceRoleArn)` The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf.
`Environment`	`withProvisioning(Provisioning provisioning)` When included, indicates that the environment template is for customer provisioned and managed infrastructure.
`Environment`	`withProvisioning(String provisioning)` When included, indicates that the environment template is for customer provisioned and managed infrastructure.
`Environment`	`withSpec(String spec)` The environment spec.
`Environment`	`withTemplateMajorVersion(String templateMajorVersion)` The ID of the major version of the environment template.
`Environment`	`withTemplateMinorVersion(String templateMinorVersion)` The ID of the minor version of the environment template.
`Environment`	`withTemplateName(String templateName)` The Amazon Resource Name (ARN) of the environment template.

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

- Constructor Detail
  - Environment
```
public Environment()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the environment.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the environment.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the environment.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the environment.
  - withArn
```
public Environment withArn(String arn)
```
    The Amazon Resource Name (ARN) of the environment.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the environment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The time when the environment was created.
    
    Parameters:
    
    createdAt - The time when the environment was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The time when the environment was created.
    
    Returns:
    
    The time when the environment was created.
  - withCreatedAt
```
public Environment withCreatedAt(Date createdAt)
```
    The time when the environment was created.
    
    Parameters:
    
    createdAt - The time when the environment was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeploymentStatus
```
public void setDeploymentStatus(String deploymentStatus)
```
    The environment deployment status.
    
    Parameters:
    
    deploymentStatus - The environment deployment status.
    
    See Also:
    
    DeploymentStatus
  - getDeploymentStatus
```
public String getDeploymentStatus()
```
    The environment deployment status.
    
    Returns:
    
    The environment deployment status.
    
    See Also:
    
    DeploymentStatus
  - withDeploymentStatus
```
public Environment withDeploymentStatus(String deploymentStatus)
```
    The environment deployment status.
    
    Parameters:
    
    deploymentStatus - The environment deployment status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeploymentStatus
  - withDeploymentStatus
```
public Environment withDeploymentStatus(DeploymentStatus deploymentStatus)
```
    The environment deployment status.
    
    Parameters:
    
    deploymentStatus - The environment deployment status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeploymentStatus
  - setDeploymentStatusMessage
```
public void setDeploymentStatusMessage(String deploymentStatusMessage)
```
    An environment deployment status message.
    
    Parameters:
    
    deploymentStatusMessage - An environment deployment status message.
  - getDeploymentStatusMessage
```
public String getDeploymentStatusMessage()
```
    An environment deployment status message.
    
    Returns:
    
    An environment deployment status message.
  - withDeploymentStatusMessage
```
public Environment withDeploymentStatusMessage(String deploymentStatusMessage)
```
    An environment deployment status message.
    
    Parameters:
    
    deploymentStatusMessage - An environment deployment status message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the environment.
    
    Parameters:
    
    description - The description of the environment.
  - getDescription
```
public String getDescription()
```
    The description of the environment.
    
    Returns:
    
    The description of the environment.
  - withDescription
```
public Environment withDescription(String description)
```
    The description of the environment.
    
    Parameters:
    
    description - The description of the environment.
    
    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's used to provision infrastructure resources in an environment account.
    
    Parameters:
    
    environmentAccountConnectionId - The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
  - getEnvironmentAccountConnectionId
```
public String getEnvironmentAccountConnectionId()
```
    The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
    
    Returns:
    
    The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
  - withEnvironmentAccountConnectionId
```
public Environment withEnvironmentAccountConnectionId(String environmentAccountConnectionId)
```
    The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
    
    Parameters:
    
    environmentAccountConnectionId - The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnvironmentAccountId
```
public void setEnvironmentAccountId(String environmentAccountId)
```
    The ID of the environment account that the environment infrastructure resources are provisioned in.
    
    Parameters:
    
    environmentAccountId - The ID of the environment account that the environment infrastructure resources are provisioned in.
  - getEnvironmentAccountId
```
public String getEnvironmentAccountId()
```
    The ID of the environment account that the environment infrastructure resources are provisioned in.
    
    Returns:
    
    The ID of the environment account that the environment infrastructure resources are provisioned in.
  - withEnvironmentAccountId
```
public Environment withEnvironmentAccountId(String environmentAccountId)
```
    The ID of the environment account that the environment infrastructure resources are provisioned in.
    
    Parameters:
    
    environmentAccountId - The ID of the environment account that the environment infrastructure resources are provisioned in.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastDeploymentAttemptedAt
```
public void setLastDeploymentAttemptedAt(Date lastDeploymentAttemptedAt)
```
    The time when a deployment of the environment was last attempted.
    
    Parameters:
    
    lastDeploymentAttemptedAt - The time when a deployment of the environment was last attempted.
  - getLastDeploymentAttemptedAt
```
public Date getLastDeploymentAttemptedAt()
```
    The time when a deployment of the environment was last attempted.
    
    Returns:
    
    The time when a deployment of the environment was last attempted.
  - withLastDeploymentAttemptedAt
```
public Environment withLastDeploymentAttemptedAt(Date lastDeploymentAttemptedAt)
```
    The time when a deployment of the environment was last attempted.
    
    Parameters:
    
    lastDeploymentAttemptedAt - The time when a deployment of the environment was last attempted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastDeploymentSucceededAt
```
public void setLastDeploymentSucceededAt(Date lastDeploymentSucceededAt)
```
    The time when the environment was last deployed successfully.
    
    Parameters:
    
    lastDeploymentSucceededAt - The time when the environment was last deployed successfully.
  - getLastDeploymentSucceededAt
```
public Date getLastDeploymentSucceededAt()
```
    The time when the environment was last deployed successfully.
    
    Returns:
    
    The time when the environment was last deployed successfully.
  - withLastDeploymentSucceededAt
```
public Environment withLastDeploymentSucceededAt(Date lastDeploymentSucceededAt)
```
    The time when the environment was last deployed successfully.
    
    Parameters:
    
    lastDeploymentSucceededAt - The time when the environment was last deployed successfully.
    
    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 Environment 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 AWS Proton service role that allows AWS Proton to make calls to other services on your behalf.
    
    Parameters:
    
    protonServiceRoleArn - The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf.
  - getProtonServiceRoleArn
```
public String getProtonServiceRoleArn()
```
    The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf.
  - withProtonServiceRoleArn
```
public Environment withProtonServiceRoleArn(String protonServiceRoleArn)
```
    The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf.
    
    Parameters:
    
    protonServiceRoleArn - The Amazon Resource Name (ARN) of the AWS Proton service role that allows AWS Proton to make calls to other services on your behalf.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProvisioning
```
public void setProvisioning(String provisioning)
```
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
    
    Parameters:
    
    provisioning - When included, indicates that the environment template is for customer provisioned and managed infrastructure.
    
    See Also:
    
    Provisioning
  - getProvisioning
```
public String getProvisioning()
```
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
    
    Returns:
    
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
    
    See Also:
    
    Provisioning
  - withProvisioning
```
public Environment withProvisioning(String provisioning)
```
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
    
    Parameters:
    
    provisioning - When included, indicates that the environment template is for customer provisioned and managed infrastructure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Provisioning
  - withProvisioning
```
public Environment withProvisioning(Provisioning provisioning)
```
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
    
    Parameters:
    
    provisioning - When included, indicates that the environment template is for customer provisioned and managed infrastructure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Provisioning
  - setSpec
```
public void setSpec(String spec)
```
    The environment spec.
    
    Parameters:
    
    spec - The environment spec.
  - getSpec
```
public String getSpec()
```
    The environment spec.
    
    Returns:
    
    The environment spec.
  - withSpec
```
public Environment withSpec(String spec)
```
    The environment spec.
    
    Parameters:
    
    spec - The environment spec.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateMajorVersion
```
public void setTemplateMajorVersion(String templateMajorVersion)
```
    The ID of the major version of the environment template.
    
    Parameters:
    
    templateMajorVersion - The ID of the major version of the environment template.
  - getTemplateMajorVersion
```
public String getTemplateMajorVersion()
```
    The ID of the major version of the environment template.
    
    Returns:
    
    The ID of the major version of the environment template.
  - withTemplateMajorVersion
```
public Environment withTemplateMajorVersion(String templateMajorVersion)
```
    The ID of the major version of the environment template.
    
    Parameters:
    
    templateMajorVersion - The ID of 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 ID of the minor version of the environment template.
    
    Parameters:
    
    templateMinorVersion - The ID of the minor version of the environment template.
  - getTemplateMinorVersion
```
public String getTemplateMinorVersion()
```
    The ID of the minor version of the environment template.
    
    Returns:
    
    The ID of the minor version of the environment template.
  - withTemplateMinorVersion
```
public Environment withTemplateMinorVersion(String templateMinorVersion)
```
    The ID of the minor version of the environment template.
    
    Parameters:
    
    templateMinorVersion - The ID of 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 Amazon Resource Name (ARN) of the environment template.
    
    Parameters:
    
    templateName - The Amazon Resource Name (ARN) of the environment template.
  - getTemplateName
```
public String getTemplateName()
```
    The Amazon Resource Name (ARN) of the environment template.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the environment template.
  - withTemplateName
```
public Environment withTemplateName(String templateName)
```
    The Amazon Resource Name (ARN) of the environment template.
    
    Parameters:
    
    templateName - The Amazon Resource Name (ARN) of the environment template.
    
    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 Environment clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Environment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Environment

Method Detail

setArn

getArn

withArn

setCreatedAt

getCreatedAt

withCreatedAt

setDeploymentStatus

getDeploymentStatus

withDeploymentStatus

withDeploymentStatus

setDeploymentStatusMessage

getDeploymentStatusMessage

withDeploymentStatusMessage

setDescription

getDescription

withDescription

setEnvironmentAccountConnectionId

getEnvironmentAccountConnectionId

withEnvironmentAccountConnectionId

setEnvironmentAccountId

getEnvironmentAccountId

withEnvironmentAccountId

setLastDeploymentAttemptedAt

getLastDeploymentAttemptedAt

withLastDeploymentAttemptedAt

setLastDeploymentSucceededAt

getLastDeploymentSucceededAt

withLastDeploymentSucceededAt

setName

getName

withName

setProtonServiceRoleArn

getProtonServiceRoleArn

withProtonServiceRoleArn

setProvisioning

getProvisioning

withProvisioning

withProvisioning

setSpec

getSpec

withSpec

setTemplateMajorVersion

getTemplateMajorVersion

withTemplateMajorVersion

setTemplateMinorVersion

getTemplateMinorVersion

withTemplateMinorVersion

setTemplateName

getTemplateName

withTemplateName

toString

equals

hashCode

clone

marshall