Interface Environment.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Environment.Builder,Environment>, SdkBuilder<Environment.Builder,Environment>, SdkPojo
Enclosing class:
Environment
@Mutable @NotThreadSafe public static interface Environment.Builder extends SdkPojo, CopyableBuilder<Environment.Builder,Environment>

  • Method Details

    • environmentId

      Environment.Builder environmentId(String environmentId)

      The unique ID for the environment.

      Parameters:
      environmentId - The unique ID for the environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environmentState

      Environment.Builder environmentState(String environmentState)

      The state of an environment.

      Parameters:
      environmentState - The state of an environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • environmentState

      Environment.Builder environmentState(EnvironmentState environmentState)

      The state of an environment.

      Parameters:
      environmentState - The state of an environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • stateDetails

      Environment.Builder stateDetails(String stateDetails)

      A detailed description of the environmentState of an environment.

      Parameters:
      stateDetails - A detailed description of the environmentState of an environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      Environment.Builder createdAt(Instant createdAt)

      The date and time that the environment was created.

      Parameters:
      createdAt - The date and time that the environment was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modifiedAt

      Environment.Builder modifiedAt(Instant modifiedAt)

      The date and time that the environment was modified.

      Parameters:
      modifiedAt - The date and time that the environment was modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environmentArn

      Environment.Builder environmentArn(String environmentArn)

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

      Parameters:
      environmentArn - The Amazon Resource Name (ARN) that is associated with the environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environmentName

      Environment.Builder environmentName(String environmentName)

      The name of the environment.

      Parameters:
      environmentName - The name of the environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcId

      Environment.Builder vpcId(String vpcId)

      The VPC associated with the environment.

      Parameters:
      vpcId - The VPC associated with the environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceAccessSubnetId

      Environment.Builder serviceAccessSubnetId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • vcfVersion

      Environment.Builder vcfVersion(String vcfVersion)

      The VCF version of the environment.

      Parameters:
      vcfVersion - The VCF version of the environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vcfVersion

      Environment.Builder vcfVersion(VcfVersion vcfVersion)

      The VCF version of the environment.

      Parameters:
      vcfVersion - The VCF version of the environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • termsAccepted

      Environment.Builder termsAccepted(Boolean termsAccepted)

      Customer confirmation that the customer has purchased and maintains sufficient VCF software licenses to cover all physical processor cores in the environment, in compliance with VMware's licensing requirements and terms of use.

      Parameters:
      termsAccepted - Customer confirmation that the customer has purchased and maintains sufficient VCF software licenses to cover all physical processor cores in the environment, in compliance with VMware's licensing requirements and terms of use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • licenseInfo

      Environment.Builder licenseInfo(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • licenseInfo

      Environment.Builder licenseInfo(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • licenseInfo

      Environment.Builder licenseInfo(Consumer<LicenseInfo.Builder>... 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.

      This is a convenience method that creates an instance of the LicenseInfo.Builder avoiding the need to create one manually via LicenseInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to licenseInfo(List<LicenseInfo>).

      Parameters:
      licenseInfo - a consumer that will call methods on LicenseInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • siteId

      Environment.Builder siteId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • environmentStatus

      Environment.Builder environmentStatus(String environmentStatus)

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

      Parameters:
      environmentStatus - Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • environmentStatus

      Environment.Builder environmentStatus(CheckResult environmentStatus)

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

      Parameters:
      environmentStatus - Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • checks

      Environment.Builder checks(Collection<Check> checks)

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

      Parameters:
      checks - A check on the environment to identify instance health and VMware VCF licensing issues.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checks

      Environment.Builder checks(Check... checks)

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

      Parameters:
      checks - A check on the environment to identify instance health and VMware VCF licensing issues.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checks

      Environment.Builder checks(Consumer<Check.Builder>... checks)

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

      This is a convenience method that creates an instance of the Check.Builder avoiding the need to create one manually via Check.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to checks(List<Check>).

      Parameters:
      checks - a consumer that will call methods on Check.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • connectivityInfo

      Environment.Builder connectivityInfo(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • connectivityInfo

      default Environment.Builder connectivityInfo(Consumer<ConnectivityInfo.Builder> 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.

      This is a convenience method that creates an instance of the ConnectivityInfo.Builder avoiding the need to create one manually via ConnectivityInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to connectivityInfo(ConnectivityInfo).

      Parameters:
      connectivityInfo - a consumer that will call methods on ConnectivityInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vcfHostnames

      Environment.Builder vcfHostnames(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • vcfHostnames

      default Environment.Builder vcfHostnames(Consumer<VcfHostnames.Builder> 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.

      This is a convenience method that creates an instance of the VcfHostnames.Builder avoiding the need to create one manually via VcfHostnames.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vcfHostnames(VcfHostnames).

      Parameters:
      vcfHostnames - a consumer that will call methods on VcfHostnames.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • kmsKeyId

      Environment.Builder kmsKeyId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • serviceAccessSecurityGroups

      Environment.Builder serviceAccessSecurityGroups(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • serviceAccessSecurityGroups

      default Environment.Builder serviceAccessSecurityGroups(Consumer<ServiceAccessSecurityGroups.Builder> 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.

      This is a convenience method that creates an instance of the ServiceAccessSecurityGroups.Builder avoiding the need to create one manually via ServiceAccessSecurityGroups.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to serviceAccessSecurityGroups(ServiceAccessSecurityGroups).

      Parameters:
      serviceAccessSecurityGroups - a consumer that will call methods on ServiceAccessSecurityGroups.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • credentials

      Environment.Builder credentials(Collection<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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • credentials

      Environment.Builder credentials(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • credentials

      Environment.Builder credentials(Consumer<Secret.Builder>... 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.

      This is a convenience method that creates an instance of the Secret.Builder avoiding the need to create one manually via Secret.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to credentials(List<Secret>).

      Parameters:
      credentials - a consumer that will call methods on Secret.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: