Class Environment

java.lang.Object
software.amazon.awssdk.services.evs.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>

An object that represents an Amazon EVS environment.

See Also:

  • Method Details

    • environmentId

      public final String environmentId()

      The unique ID for the environment.

      Returns:
      The unique ID for the environment.

    • environmentState

      public final EnvironmentState environmentState()

      The state of an environment.

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

      Returns:
      The state of an environment.
      See Also:

    • environmentStateAsString

      public final String environmentStateAsString()

      The state of an environment.

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

      Returns:
      The state of an environment.
      See Also:

    • stateDetails

      public final String stateDetails()

      A detailed description of the environmentState of an environment.

      Returns:
      A detailed description of the environmentState of an environment.

    • createdAt

      public final Instant createdAt()

      The date and time that the environment was created.

      Returns:
      The date and time that the environment was created.

    • modifiedAt

      public final Instant modifiedAt()

      The date and time that the environment was modified.

      Returns:
      The date and time that the environment was modified.

    • environmentArn

      public final String environmentArn()

      The Amazon Resource Name (ARN) that is associated with the environment.

      Returns:
      The Amazon Resource Name (ARN) that is associated with the environment.

    • environmentName

      public final String environmentName()

      The name of the environment.

      Returns:
      The name of the environment.

    • vpcId

      public final String vpcId()

      The VPC associated with the environment.

      Returns:
      The VPC associated with the environment.

    • serviceAccessSubnetId

      public final String serviceAccessSubnetId()

      The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. Amazon EVS uses this subnet to perform validations and create the environment.

      Returns:
      The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC. Amazon EVS uses this subnet to perform validations and create the environment.

    • vcfVersion

      public final VcfVersion vcfVersion()

      The VCF version of the environment.

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

      Returns:
      The VCF version of the environment.
      See Also:

    • vcfVersionAsString

      public final String vcfVersionAsString()

      The VCF version of the environment.

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

      Returns:
      The VCF version of the environment.
      See Also:

    • termsAccepted

      public final Boolean termsAccepted()

      Customer confirmation that the customer has purchased and will continue to maintain the required number of VCF software licenses to cover all physical processor cores in the Amazon EVS environment. Information about your VCF software in Amazon EVS will be shared with Broadcom to verify license compliance. Amazon EVS does not validate license keys. To validate license keys, visit the Broadcom support portal.

      Returns:
      Customer confirmation that the customer has purchased and will continue to maintain the required number of VCF software licenses to cover all physical processor cores in the Amazon EVS environment. Information about your VCF software in Amazon EVS will be shared with Broadcom to verify license compliance. Amazon EVS does not validate license keys. To validate license keys, visit the Broadcom support portal.

    • hasLicenseInfo

      public final boolean hasLicenseInfo()
      For responses, this returns true if the service returned a value for the LicenseInfo 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.

    • licenseInfo

      public final List<LicenseInfo> licenseInfo()

      The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key. The VCF solution key must cover a minimum of 256 cores. The vSAN license key must provide at least 110 TiB of vSAN capacity.

      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 hasLicenseInfo() method.

      Returns:
      The license information that Amazon EVS requires to create an environment. Amazon EVS requires two license keys: a VCF solution key and a vSAN license key. The VCF solution key must cover a minimum of 256 cores. The vSAN license key must provide at least 110 TiB of vSAN capacity.

    • siteId

      public final String siteId()

      The Broadcom Site ID that is associated with your Amazon EVS environment. Amazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS.

      Returns:
      The Broadcom Site ID that is associated with your Amazon EVS environment. Amazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS.

    • environmentStatus

      public final CheckResult environmentStatus()

      Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.

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

      Returns:
      Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
      See Also:

    • environmentStatusAsString

      public final String environmentStatusAsString()

      Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.

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

      Returns:
      Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
      See Also:

    • hasChecks

      public final boolean hasChecks()
      For responses, this returns true if the service returned a value for the Checks 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.

    • checks

      public final List<Check> checks()

      A check on the environment to identify instance health and VMware VCF licensing issues.

      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 hasChecks() method.

      Returns:
      A check on the environment to identify instance health and VMware VCF licensing issues.

    • connectivityInfo

      public final ConnectivityInfo connectivityInfo()

      The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.

      Returns:
      The connectivity configuration for the environment. Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.

    • vcfHostnames

      public final VcfHostnames vcfHostnames()

      The DNS hostnames to be used by the VCF management appliances in your environment.

      For environment creation to be successful, each hostname entry must resolve to a domain name that you've registered in your DNS service of choice and configured in the DHCP option set of your VPC. DNS hostnames cannot be changed after environment creation has started.

      Returns:
      The DNS hostnames to be used by the VCF management appliances in your environment.

      For environment creation to be successful, each hostname entry must resolve to a domain name that you've registered in your DNS service of choice and configured in the DHCP option set of your VPC. DNS hostnames cannot be changed after environment creation has started.

    • kmsKeyId

      public final String kmsKeyId()

      The Amazon Web Services KMS key ID that Amazon Web Services Secrets Manager uses to encrypt secrets that are associated with the environment. These secrets contain the VCF credentials that are needed to install vCenter Server, NSX, and SDDC Manager.

      By default, Amazon EVS use the Amazon Web Services Secrets Manager managed key aws/secretsmanager. You can also specify a customer managed key.

      Returns:
      The Amazon Web Services KMS key ID that Amazon Web Services Secrets Manager uses to encrypt secrets that are associated with the environment. These secrets contain the VCF credentials that are needed to install vCenter Server, NSX, and SDDC Manager.

      By default, Amazon EVS use the Amazon Web Services Secrets Manager managed key aws/secretsmanager. You can also specify a customer managed key.

    • serviceAccessSecurityGroups

      public final ServiceAccessSecurityGroups serviceAccessSecurityGroups()

      The security groups that allow traffic between the Amazon EVS control plane and your VPC for service access. If a security group is not specified, Amazon EVS uses the default security group in your account for service access.

      Returns:
      The security groups that allow traffic between the Amazon EVS control plane and your VPC for service access. If a security group is not specified, Amazon EVS uses the default security group in your account for service access.

    • hasCredentials

      public final boolean hasCredentials()
      For responses, this returns true if the service returned a value for the Credentials 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.

    • credentials

      public final List<Secret> credentials()

      The VCF credentials that are stored as Amazon EVS managed secrets in Amazon Web Services Secrets Manager.

      Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager.

      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 hasCredentials() method.

      Returns:
      The VCF credentials that are stored as Amazon EVS managed secrets in Amazon Web Services Secrets Manager.

      Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager.

    • toBuilder

      public Environment.Builder 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 interface ToCopyableBuilder<Environment.Builder,Environment>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.