java.lang.Object
- software.amazon.awssdk.services.proton.model.Environment

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Environment.Builder,Environment>
```
@Generated("software.amazon.awssdk:codegen")
public final class Environment
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Environment.Builder,Environment>
```
Detailed data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Environment.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	The Amazon Resource Name (ARN) of the environment.
`static Environment.Builder`	`builder()`
`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.
`String`	`componentRoleArn()`	The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment.
`Instant`	`createdAt()`	The time when the environment was created.
`DeploymentStatus`	`deploymentStatus()`	The environment deployment status.
`String`	`deploymentStatusAsString()`	The environment deployment status.
`String`	`deploymentStatusMessage()`	An environment deployment status message.
`String`	`description()`	The description of the environment.
`String`	`environmentAccountConnectionId()`	The ID of the environment account connection that's used to provision infrastructure resources in an environment account.
`String`	`environmentAccountId()`	The ID of the environment account that the environment infrastructure resources are provisioned in.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`lastAttemptedDeploymentId()`	The ID of the last attempted deployment of this environment.
`Instant`	`lastDeploymentAttemptedAt()`	The time when a deployment of the environment was last attempted.
`Instant`	`lastDeploymentSucceededAt()`	The time when the environment was last deployed successfully.
`String`	`lastSucceededDeploymentId()`	The ID of the last successful deployment of this environment.
`String`	`name()`	The name of the environment.
`String`	`protonServiceRoleArn()`	The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
`Provisioning`	`provisioning()`	When included, indicates that the environment template is for customer provisioned and managed infrastructure.
`String`	`provisioningAsString()`	When included, indicates that the environment template is for customer provisioned and managed infrastructure.
`RepositoryBranch`	`provisioningRepository()`	The linked repository that you use to host your rendered infrastructure templates for self-managed provisioning.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Environment.Builder>`	`serializableBuilderClass()`
`String`	`spec()`	The environment spec.
`String`	`templateMajorVersion()`	The major version of the environment template.
`String`	`templateMinorVersion()`	The minor version of the environment template.
`String`	`templateName()`	The Amazon Resource Name (ARN) of the environment template.
`Environment.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the environment.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the environment.
  - codebuildRoleArn
```
public final 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.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM service role that allows Proton to provision infrastructure using CodeBuild-based provisioning on your behalf.
  - componentRoleArn
```
public final 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.
    
    The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
    
    For more information about components, see Proton components in the Proton User 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.
    
    The environment must have a componentRoleArn to allow directly defined components to be associated with the environment.
    
    For more information about components, see Proton components in the Proton User Guide.
  - createdAt
```
public final Instant createdAt()
```
    The time when the environment was created.
    
    Returns:
    
    The time when the environment was created.
  - deploymentStatus
```
public final DeploymentStatus deploymentStatus()
```
    The environment deployment status.
    
    If the service returns an enum value that is not available in the current SDK version, deploymentStatus will return DeploymentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentStatusAsString().
    
    Returns:
    
    The environment deployment status.
    
    See Also:
    
    DeploymentStatus
  - deploymentStatusAsString
```
public final String deploymentStatusAsString()
```
    The environment deployment status.
    
    If the service returns an enum value that is not available in the current SDK version, deploymentStatus will return DeploymentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentStatusAsString().
    
    Returns:
    
    The environment deployment status.
    
    See Also:
    
    DeploymentStatus
  - deploymentStatusMessage
```
public final String deploymentStatusMessage()
```
    An environment deployment status message.
    
    Returns:
    
    An environment deployment status message.
  - description
```
public final String description()
```
    The description of the environment.
    
    Returns:
    
    The description of the environment.
  - environmentAccountConnectionId
```
public final String environmentAccountConnectionId()
```
    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.
  - environmentAccountId
```
public final String environmentAccountId()
```
    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.
  - lastAttemptedDeploymentId
```
public final String lastAttemptedDeploymentId()
```
    The ID of the last attempted deployment of this environment.
    
    Returns:
    
    The ID of the last attempted deployment of this environment.
  - lastDeploymentAttemptedAt
```
public final Instant lastDeploymentAttemptedAt()
```
    The time when a deployment of the environment was last attempted.
    
    Returns:
    
    The time when a deployment of the environment was last attempted.
  - lastDeploymentSucceededAt
```
public final Instant lastDeploymentSucceededAt()
```
    The time when the environment was last deployed successfully.
    
    Returns:
    
    The time when the environment was last deployed successfully.
  - lastSucceededDeploymentId
```
public final String lastSucceededDeploymentId()
```
    The ID of the last successful deployment of this environment.
    
    Returns:
    
    The ID of the last successful deployment of this environment.
  - name
```
public final String name()
```
    The name of the environment.
    
    Returns:
    
    The name of the environment.
  - protonServiceRoleArn
```
public final String protonServiceRoleArn()
```
    The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.
  - provisioning
```
public final Provisioning provisioning()
```
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
    
    If the service returns an enum value that is not available in the current SDK version, provisioning will return Provisioning.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from provisioningAsString().
    
    Returns:
    
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
    
    See Also:
    
    Provisioning
  - provisioningAsString
```
public final String provisioningAsString()
```
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
    
    If the service returns an enum value that is not available in the current SDK version, provisioning will return Provisioning.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from provisioningAsString().
    
    Returns:
    
    When included, indicates that the environment template is for customer provisioned and managed infrastructure.
    
    See Also:
    
    Provisioning
  - provisioningRepository
```
public final RepositoryBranch 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.
    
    Returns:
    
    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.
  - spec
```
public final String spec()
```
    The environment spec.
    
    Returns:
    
    The environment spec.
  - templateMajorVersion
```
public final String templateMajorVersion()
```
    The major version of the environment template.
    
    Returns:
    
    The major version of the environment template.
  - templateMinorVersion
```
public final String templateMinorVersion()
```
    The minor version of the environment template.
    
    Returns:
    
    The minor version of the environment template.
  - templateName
```
public final String templateName()
```
    The Amazon Resource Name (ARN) of the environment template.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the environment template.
  - toBuilder
```
public Environment.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Environment.Builder,Environment>
  - builder
```
public static Environment.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Environment.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Environment

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

codebuildRoleArn

componentRoleArn

createdAt

deploymentStatus

deploymentStatusAsString

deploymentStatusMessage

description

environmentAccountConnectionId

environmentAccountId

lastAttemptedDeploymentId

lastDeploymentAttemptedAt

lastDeploymentSucceededAt

lastSucceededDeploymentId

name

protonServiceRoleArn

provisioning

provisioningAsString

provisioningRepository

spec

templateMajorVersion

templateMinorVersion

templateName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields