Package software.amazon.awssdk.services.m2.model

Class GetEnvironmentResponse

    • Method Detail

      • actualCapacity

        public final Integer actualCapacity()

        The number of instances included in the runtime environment. A standalone runtime environment has a maximum of one instance. Currently, a high availability runtime environment has a maximum of two instances.

        Returns:
        The number of instances included in the runtime environment. A standalone runtime environment has a maximum of one instance. Currently, a high availability runtime environment has a maximum of two instances.

      • creationTime

        public final Instant creationTime()

        The timestamp when the runtime environment was created.

        Returns:
        The timestamp when the runtime environment was created.

      • description

        public final String description()

        The description of the runtime environment.

        Returns:
        The description of the runtime environment.

      • engineTypeAsString

        public final String engineTypeAsString()

        The target platform for the runtime environment.

        If the service returns an enum value that is not available in the current SDK version, engineType will return EngineType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from engineTypeAsString().

        Returns:
        The target platform for the runtime environment.
        See Also:
        EngineType

      • engineVersion

        public final String engineVersion()

        The version of the runtime engine.

        Returns:
        The version of the runtime engine.

      • environmentArn

        public final String environmentArn()

        The Amazon Resource Name (ARN) of the runtime environment.

        Returns:
        The Amazon Resource Name (ARN) of the runtime environment.

      • environmentId

        public final String environmentId()

        The unique identifier of the runtime environment.

        Returns:
        The unique identifier of the runtime environment.

      • highAvailabilityConfig

        public final HighAvailabilityConfig highAvailabilityConfig()

        The desired capacity of the high availability configuration for the runtime environment.

        Returns:
        The desired capacity of the high availability configuration for the runtime environment.

      • instanceType

        public final String instanceType()

        The type of instance underlying the runtime environment.

        Returns:
        The type of instance underlying the runtime environment.

      • kmsKeyId

        public final String kmsKeyId()

        The identifier of a customer managed key.

        Returns:
        The identifier of a customer managed key.

      • loadBalancerArn

        public final String loadBalancerArn()

        The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.

        Returns:
        The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.

      • name

        public final String name()

        The name of the runtime environment. Must be unique within the account.

        Returns:
        The name of the runtime environment. Must be unique within the account.

      • pendingMaintenance

        public final PendingMaintenance pendingMaintenance()

        Indicates the pending maintenance scheduled on this environment.

        Returns:
        Indicates the pending maintenance scheduled on this environment.

      • preferredMaintenanceWindow

        public final String preferredMaintenanceWindow()

        The maintenance window for the runtime environment. If you don't provide a value for the maintenance window, the service assigns a random value.

        Returns:
        The maintenance window for the runtime environment. If you don't provide a value for the maintenance window, the service assigns a random value.

      • publiclyAccessible

        public final Boolean publiclyAccessible()

        Whether applications running in this runtime environment are publicly accessible.

        Returns:
        Whether applications running in this runtime environment are publicly accessible.

      • hasSecurityGroupIds

        public final boolean hasSecurityGroupIds()
        For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • securityGroupIds

        public final List<String> securityGroupIds()

        The unique identifiers of the security groups assigned to this runtime environment.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroupIds() method.

        Returns:
        The unique identifiers of the security groups assigned to this runtime environment.

      • statusReason

        public final String statusReason()

        The reason for the reported status.

        Returns:
        The reason for the reported status.

      • hasStorageConfigurations

        public final boolean hasStorageConfigurations()
        For responses, this returns true if the service returned a value for the StorageConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • storageConfigurations

        public final List<StorageConfiguration> storageConfigurations()

        The storage configurations defined for the runtime environment.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStorageConfigurations() method.

        Returns:
        The storage configurations defined for the runtime environment.

      • hasSubnetIds

        public final boolean hasSubnetIds()
        For responses, this returns true if the service returned a value for the SubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • subnetIds

        public final List<String> subnetIds()

        The unique identifiers of the subnets assigned to this runtime environment.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnetIds() method.

        Returns:
        The unique identifiers of the subnets assigned to this runtime environment.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final Map<String,​String> tags()

        The tags defined for this runtime environment.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        The tags defined for this runtime environment.

      • vpcId

        public final String vpcId()

        The unique identifier for the VPC used with this runtime environment.

        Returns:
        The unique identifier for the VPC used with this runtime environment.

      • 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