Interface CreateEnvironmentRequest.Builder

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

  • Method Details

    • clientToken

      CreateEnvironmentRequest.Builder clientToken(String clientToken)

      This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

      Parameters:
      clientToken -

      This parameter is not used in Amazon EVS currently. If you supply input for this parameter, it will have no effect.

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the environment creation request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.

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

    • environmentName

      CreateEnvironmentRequest.Builder environmentName(String environmentName)

      The name to give to your environment. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphanumeric character, and can't be longer than 100 characters. The name must be unique within the Amazon Web Services Region and Amazon Web Services account that you're creating the environment in.

      Parameters:
      environmentName - The name to give to your environment. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphanumeric character, and can't be longer than 100 characters. The name must be unique within the Amazon Web Services Region and Amazon Web Services account that you're creating the environment in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      CreateEnvironmentRequest.Builder kmsKeyId(String kmsKeyId)

      A unique ID for the customer-managed KMS key that is used to encrypt the VCF credential pairs for SDDC Manager, NSX Manager, and vCenter appliances. These credentials are stored in Amazon Web Services Secrets Manager.

      Parameters:
      kmsKeyId - A unique ID for the customer-managed KMS key that is used to encrypt the VCF credential pairs for SDDC Manager, NSX Manager, and vCenter appliances. These credentials are stored in Amazon Web Services Secrets Manager.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateEnvironmentRequest.Builder tags(Map<String,String> tags)

      Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.

      Parameters:
      tags - Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • serviceAccessSecurityGroups

      CreateEnvironmentRequest.Builder serviceAccessSecurityGroups(ServiceAccessSecurityGroups serviceAccessSecurityGroups)

      The security group that controls communication between the Amazon EVS control plane and VPC. The default security group is used if a custom security group isn't specified.

      The security group should allow access to the following.

      • TCP/UDP access to the DNS servers

      • HTTPS/SSH access to the host management VLAN subnet

      • HTTPS/SSH access to the Management VM VLAN subnet

      You should avoid modifying the security group rules after deployment, as this can break the persistent connection between the Amazon EVS control plane and VPC. This can cause future environment actions like adding or removing hosts to fail.

      Parameters:
      serviceAccessSecurityGroups - The security group that controls communication between the Amazon EVS control plane and VPC. The default security group is used if a custom security group isn't specified.

      The security group should allow access to the following.

      • TCP/UDP access to the DNS servers

      • HTTPS/SSH access to the host management VLAN subnet

      • HTTPS/SSH access to the Management VM VLAN subnet

      You should avoid modifying the security group rules after deployment, as this can break the persistent connection between the Amazon EVS control plane and VPC. This can cause future environment actions like adding or removing hosts to fail.

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

    • serviceAccessSecurityGroups

      default CreateEnvironmentRequest.Builder serviceAccessSecurityGroups(Consumer<ServiceAccessSecurityGroups.Builder> serviceAccessSecurityGroups)

      The security group that controls communication between the Amazon EVS control plane and VPC. The default security group is used if a custom security group isn't specified.

      The security group should allow access to the following.

      • TCP/UDP access to the DNS servers

      • HTTPS/SSH access to the host management VLAN subnet

      • HTTPS/SSH access to the Management VM VLAN subnet

      You should avoid modifying the security group rules after deployment, as this can break the persistent connection between the Amazon EVS control plane and VPC. This can cause future environment actions like adding or removing hosts to fail.

      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:

    • vpcId

      CreateEnvironmentRequest.Builder vpcId(String vpcId)

      A unique ID for the VPC that connects to the environment control plane for service access.

      Amazon EVS requires that all VPC subnets exist in a single Availability Zone in a Region where the service is available.

      The VPC that you select must have a valid DHCP option set with domain name, at least two DNS servers, and an NTP server. These settings are used to configure your VCF appliances and hosts.

      If you plan to use HCX over the internet, choose a VPC that has a primary CIDR block and a /28 secondary CIDR block from an IPAM pool. Make sure that your VPC also has an attached internet gateway.

      Amazon EVS does not support the following Amazon Web Services networking options for NSX overlay connectivity: cross-Region VPC peering, Amazon S3 gateway endpoints, or Amazon Web Services Direct Connect virtual private gateway associations.

      Parameters:
      vpcId - A unique ID for the VPC that connects to the environment control plane for service access.

      Amazon EVS requires that all VPC subnets exist in a single Availability Zone in a Region where the service is available.

      The VPC that you select must have a valid DHCP option set with domain name, at least two DNS servers, and an NTP server. These settings are used to configure your VCF appliances and hosts.

      If you plan to use HCX over the internet, choose a VPC that has a primary CIDR block and a /28 secondary CIDR block from an IPAM pool. Make sure that your VPC also has an attached internet gateway.

      Amazon EVS does not support the following Amazon Web Services networking options for NSX overlay connectivity: cross-Region VPC peering, Amazon S3 gateway endpoints, or Amazon Web Services Direct Connect virtual private gateway associations.

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

    • serviceAccessSubnetId

      CreateEnvironmentRequest.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 validate mandatory DNS records for your VCF appliances and hosts 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 validate mandatory DNS records for your VCF appliances and hosts and create the environment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vcfVersion

      CreateEnvironmentRequest.Builder vcfVersion(String vcfVersion)

      The VCF version to use for the environment. Amazon EVS only supports VCF version 5.2.1 at this time.

      Parameters:
      vcfVersion - The VCF version to use for the environment. Amazon EVS only supports VCF version 5.2.1 at this time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vcfVersion

      CreateEnvironmentRequest.Builder vcfVersion(VcfVersion vcfVersion)

      The VCF version to use for the environment. Amazon EVS only supports VCF version 5.2.1 at this time.

      Parameters:
      vcfVersion - The VCF version to use for the environment. Amazon EVS only supports VCF version 5.2.1 at this time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • termsAccepted

      CreateEnvironmentRequest.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

      CreateEnvironmentRequest.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. VCF licenses must have sufficient core entitlements to cover vCPU core and vSAN storage capacity needs.

      VCF licenses can be used for only one Amazon EVS environment. Amazon EVS does not support reuse of VCF licenses for multiple environments.

      VCF license information can be retrieved from the Broadcom portal.

      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. VCF licenses must have sufficient core entitlements to cover vCPU core and vSAN storage capacity needs.

      VCF licenses can be used for only one Amazon EVS environment. Amazon EVS does not support reuse of VCF licenses for multiple environments.

      VCF license information can be retrieved from the Broadcom portal.

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

    • licenseInfo

      CreateEnvironmentRequest.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. VCF licenses must have sufficient core entitlements to cover vCPU core and vSAN storage capacity needs.

      VCF licenses can be used for only one Amazon EVS environment. Amazon EVS does not support reuse of VCF licenses for multiple environments.

      VCF license information can be retrieved from the Broadcom portal.

      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. VCF licenses must have sufficient core entitlements to cover vCPU core and vSAN storage capacity needs.

      VCF licenses can be used for only one Amazon EVS environment. Amazon EVS does not support reuse of VCF licenses for multiple environments.

      VCF license information can be retrieved from the Broadcom portal.

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

    • licenseInfo

      CreateEnvironmentRequest.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. VCF licenses must have sufficient core entitlements to cover vCPU core and vSAN storage capacity needs.

      VCF licenses can be used for only one Amazon EVS environment. Amazon EVS does not support reuse of VCF licenses for multiple environments.

      VCF license information can be retrieved from the Broadcom portal.

      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:

    • initialVlans

      CreateEnvironmentRequest.Builder initialVlans(InitialVlans initialVlans)

      The initial VLAN subnets for the environment. You must specify a non-overlapping CIDR block for each VLAN subnet.

      Parameters:
      initialVlans - The initial VLAN subnets for the environment. You must specify a non-overlapping CIDR block for each VLAN subnet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • initialVlans

      default CreateEnvironmentRequest.Builder initialVlans(Consumer<InitialVlans.Builder> initialVlans)

      The initial VLAN subnets for the environment. You must specify a non-overlapping CIDR block for each VLAN subnet.

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

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

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

    • hosts

      CreateEnvironmentRequest.Builder hosts(Collection<HostInfoForCreate> hosts)

      The ESXi hosts to add to the environment. Amazon EVS requires that you provide details for a minimum of 4 hosts during environment creation.

      For each host, you must provide the desired hostname, EC2 SSH key, and EC2 instance type. Optionally, you can also provide a partition or cluster placement group to use, or use Amazon EC2 Dedicated Hosts.

      Parameters:
      hosts - The ESXi hosts to add to the environment. Amazon EVS requires that you provide details for a minimum of 4 hosts during environment creation.

      For each host, you must provide the desired hostname, EC2 SSH key, and EC2 instance type. Optionally, you can also provide a partition or cluster placement group to use, or use Amazon EC2 Dedicated Hosts.

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

    • hosts

      CreateEnvironmentRequest.Builder hosts(HostInfoForCreate... hosts)

      The ESXi hosts to add to the environment. Amazon EVS requires that you provide details for a minimum of 4 hosts during environment creation.

      For each host, you must provide the desired hostname, EC2 SSH key, and EC2 instance type. Optionally, you can also provide a partition or cluster placement group to use, or use Amazon EC2 Dedicated Hosts.

      Parameters:
      hosts - The ESXi hosts to add to the environment. Amazon EVS requires that you provide details for a minimum of 4 hosts during environment creation.

      For each host, you must provide the desired hostname, EC2 SSH key, and EC2 instance type. Optionally, you can also provide a partition or cluster placement group to use, or use Amazon EC2 Dedicated Hosts.

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

    • hosts

      CreateEnvironmentRequest.Builder hosts(Consumer<HostInfoForCreate.Builder>... hosts)

      The ESXi hosts to add to the environment. Amazon EVS requires that you provide details for a minimum of 4 hosts during environment creation.

      For each host, you must provide the desired hostname, EC2 SSH key, and EC2 instance type. Optionally, you can also provide a partition or cluster placement group to use, or use Amazon EC2 Dedicated Hosts.

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

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

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

    • connectivityInfo

      CreateEnvironmentRequest.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 edges over the NSX, providing BGP dynamic routing for overlay networks.

      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 edges over the NSX, providing BGP dynamic routing for overlay networks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • connectivityInfo

      default CreateEnvironmentRequest.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 edges over the NSX, providing BGP dynamic routing for overlay networks.

      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

      CreateEnvironmentRequest.Builder vcfHostnames(VcfHostnames vcfHostnames)

      The DNS hostnames for the virtual machines that host the VCF management appliances. Amazon EVS requires that you provide DNS hostnames for the following appliances: vCenter, NSX Manager, SDDC Manager, and Cloud Builder.

      Parameters:
      vcfHostnames - The DNS hostnames for the virtual machines that host the VCF management appliances. Amazon EVS requires that you provide DNS hostnames for the following appliances: vCenter, NSX Manager, SDDC Manager, and Cloud Builder.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vcfHostnames

      default CreateEnvironmentRequest.Builder vcfHostnames(Consumer<VcfHostnames.Builder> vcfHostnames)

      The DNS hostnames for the virtual machines that host the VCF management appliances. Amazon EVS requires that you provide DNS hostnames for the following appliances: vCenter, NSX Manager, SDDC Manager, and Cloud Builder.

      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:

    • siteId

      CreateEnvironmentRequest.Builder siteId(String siteId)

      The Broadcom Site ID that is allocated to you as part of your electronic software delivery. This ID allows customer access to the Broadcom portal, and is provided to you by Broadcom at the close of your software contract or contract renewal. 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 allocated to you as part of your electronic software delivery. This ID allows customer access to the Broadcom portal, and is provided to you by Broadcom at the close of your software contract or contract renewal. 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.

    • overrideConfiguration

      CreateEnvironmentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateEnvironmentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.