Class EnvironmentSummary

    • Method Detail

      • arn

        public final String arn()

        The Amazon Resource Name (ARN) of the environment.

        Returns:
        The Amazon Resource Name (ARN) of the environment.
      • 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.
      • 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 the environment is associated with.

        Returns:
        The ID of the environment account connection that the environment is associated with.
      • 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
      • 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 name of the environment template.

        Returns:
        The name of the environment template.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)