Class EnvironmentSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<EnvironmentSummary.Builder,
EnvironmentSummary>
Summary data of an Proton environment resource. An Proton environment is a set of resources shared across Proton services.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the environment.static EnvironmentSummary.Builder
builder()
final String
The Amazon Resource Name (ARN) of the IAM service role that Proton uses when provisioning directly defined components in this environment.final Instant
The time when the environment was created.final DeploymentStatus
The environment deployment status.final String
The environment deployment status.final String
An environment deployment status message.final String
The description of the environment.final String
The ID of the environment account connection that the environment is associated with.final String
The ID of the environment account that the environment infrastructure resources are provisioned in.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The ID of the last attempted deployment of this environment.final Instant
The time when a deployment of the environment was last attempted.final Instant
The time when the environment was last deployed successfully.final String
The ID of the last successful deployment of this environment.final String
name()
The name of the environment.final String
The Amazon Resource Name (ARN) of the Proton service role that allows Proton to make calls to other services on your behalf.final Provisioning
When included, indicates that the environment template is for customer provisioned and managed infrastructure.final String
When included, indicates that the environment template is for customer provisioned and managed infrastructure.static Class
<? extends EnvironmentSummary.Builder> final String
The major version of the environment template.final String
The minor version of the environment template.final String
The name of the environment template.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the environment.
- Returns:
- The Amazon Resource Name (ARN) of the environment.
-
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
The time when the environment was created.
- Returns:
- The time when the environment was created.
-
deploymentStatus
The environment deployment status.
If the service returns an enum value that is not available in the current SDK version,
deploymentStatus
will returnDeploymentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeploymentStatusAsString()
.- Returns:
- The environment deployment status.
- See Also:
-
deploymentStatusAsString
The environment deployment status.
If the service returns an enum value that is not available in the current SDK version,
deploymentStatus
will returnDeploymentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeploymentStatusAsString()
.- Returns:
- The environment deployment status.
- See Also:
-
deploymentStatusMessage
An environment deployment status message.
- Returns:
- An environment deployment status message.
-
description
The description of the environment.
- Returns:
- The description of the environment.
-
environmentAccountConnectionId
The ID of the environment account connection that the environment is associated with.
- Returns:
- The ID of the environment account connection that the environment is associated with.
-
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
The ID of the last attempted deployment of this environment.
- Returns:
- The ID of the last attempted deployment of this environment.
-
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
The time when the environment was last deployed successfully.
- Returns:
- The time when the environment was last deployed successfully.
-
lastSucceededDeploymentId
The ID of the last successful deployment of this environment.
- Returns:
- The ID of the last successful deployment of this environment.
-
name
The name of the environment.
- Returns:
- The name of the environment.
-
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
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 returnProvisioning.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprovisioningAsString()
.- Returns:
- When included, indicates that the environment template is for customer provisioned and managed infrastructure.
- See Also:
-
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 returnProvisioning.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprovisioningAsString()
.- Returns:
- When included, indicates that the environment template is for customer provisioned and managed infrastructure.
- See Also:
-
templateMajorVersion
The major version of the environment template.
- Returns:
- The major version of the environment template.
-
templateMinorVersion
The minor version of the environment template.
- Returns:
- The minor version of the environment template.
-
templateName
The name of the environment template.
- Returns:
- The name of the environment template.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<EnvironmentSummary.Builder,
EnvironmentSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-