Package software.amazon.awscdk.services.evs

Class CfnEnvironment.Builder

java.lang.Object

software.amazon.awscdk.services.evs.CfnEnvironment.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEnvironment>

Enclosing class:

CfnEnvironment

@Stability(Stable)
public static final class CfnEnvironment.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEnvironment>

A fluent builder for CfnEnvironment.

Method Summary

Modifier and Type	Method	Description
CfnEnvironment	build()
CfnEnvironment.Builder	connectivityInfo(IResolvable connectivityInfo)	The connectivity configuration for the environment.
CfnEnvironment.Builder	connectivityInfo(CfnEnvironment.ConnectivityInfoProperty connectivityInfo)	The connectivity configuration for the environment.
static CfnEnvironment.Builder	create(software.constructs.Construct scope, String id)
CfnEnvironment.Builder	environmentName(String environmentName)	The name of the environment.
CfnEnvironment.Builder	hosts(List<? extends Object> hosts)	Required for environment resource creation.
CfnEnvironment.Builder	hosts(IResolvable hosts)	Required for environment resource creation.
CfnEnvironment.Builder	initialVlans(IResolvable initialVlans)
CfnEnvironment.Builder	initialVlans(CfnEnvironment.InitialVlansProperty initialVlans)
CfnEnvironment.Builder	kmsKeyId(String kmsKeyId)	The AWS KMS key ID that AWS Secrets Manager uses to encrypt secrets that are associated with the environment.
CfnEnvironment.Builder	licenseInfo(IResolvable licenseInfo)	The license information that Amazon EVS requires to create an environment.
CfnEnvironment.Builder	licenseInfo(CfnEnvironment.LicenseInfoProperty licenseInfo)	The license information that Amazon EVS requires to create an environment.
CfnEnvironment.Builder	serviceAccessSecurityGroups(IResolvable serviceAccessSecurityGroups)	The security groups that allow traffic between the Amazon EVS control plane and your VPC for service access.
CfnEnvironment.Builder	serviceAccessSecurityGroups(CfnEnvironment.ServiceAccessSecurityGroupsProperty serviceAccessSecurityGroups)	The security groups that allow traffic between the Amazon EVS control plane and your VPC for service access.
CfnEnvironment.Builder	serviceAccessSubnetId(String serviceAccessSubnetId)	The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC.
CfnEnvironment.Builder	siteId(String siteId)	The Broadcom Site ID that is associated with your Amazon EVS environment.
CfnEnvironment.Builder	tags(List<? extends CfnTag> tags)	Metadata that assists with categorization and organization.
CfnEnvironment.Builder	termsAccepted(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.
CfnEnvironment.Builder	termsAccepted(IResolvable 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.
CfnEnvironment.Builder	vcfHostnames(IResolvable vcfHostnames)	The DNS hostnames to be used by the VCF management appliances in your environment.
CfnEnvironment.Builder	vcfHostnames(CfnEnvironment.VcfHostnamesProperty vcfHostnames)	The DNS hostnames to be used by the VCF management appliances in your environment.
CfnEnvironment.Builder	vcfVersion(String vcfVersion)	The VCF version of the environment.
CfnEnvironment.Builder	vpcId(String vpcId)	The VPC associated with the environment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnEnvironment.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnEnvironment.Builder.

connectivityInfo

@Stability(Stable)
public CfnEnvironment.Builder connectivityInfo(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-connectivityinfo

connectivityInfo

@Stability(Stable)
public CfnEnvironment.Builder connectivityInfo(CfnEnvironment.ConnectivityInfoProperty 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-connectivityinfo

licenseInfo

@Stability(Stable)
public CfnEnvironment.Builder licenseInfo(IResolvable 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.

Parameters:

licenseInfo - The license information that Amazon EVS requires to create an environment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-licenseinfo

licenseInfo

@Stability(Stable)
public CfnEnvironment.Builder licenseInfo(CfnEnvironment.LicenseInfoProperty 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.

Parameters:

licenseInfo - The license information that Amazon EVS requires to create an environment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-licenseinfo

serviceAccessSubnetId

@Stability(Stable)
public CfnEnvironment.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-serviceaccesssubnetid

siteId

@Stability(Stable)
public CfnEnvironment.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-siteid

termsAccepted

@Stability(Stable)
public CfnEnvironment.Builder termsAccepted(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.

Parameters:

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-termsaccepted

termsAccepted

@Stability(Stable)
public CfnEnvironment.Builder termsAccepted(IResolvable 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.

Parameters:

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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-termsaccepted

vcfHostnames

@Stability(Stable)
public CfnEnvironment.Builder vcfHostnames(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-vcfhostnames

vcfHostnames

@Stability(Stable)
public CfnEnvironment.Builder vcfHostnames(CfnEnvironment.VcfHostnamesProperty 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-vcfhostnames

vcfVersion

@Stability(Stable)
public CfnEnvironment.Builder vcfVersion(String vcfVersion)

The VCF version of the environment.

Parameters:

vcfVersion - The VCF version of the environment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-vcfversion

vpcId

@Stability(Stable)
public CfnEnvironment.Builder vpcId(String vpcId)

The VPC associated with the environment.

Parameters:

vpcId - The VPC associated with the environment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-vpcid

environmentName

@Stability(Stable)
public CfnEnvironment.Builder environmentName(String environmentName)

The name of the environment.

Parameters:

environmentName - The name of the environment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-environmentname

hosts

@Stability(Stable)
public CfnEnvironment.Builder hosts(IResolvable hosts)

Required for environment resource creation.

Parameters:

hosts - Required for environment resource creation. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-hosts

hosts

@Stability(Stable)
public CfnEnvironment.Builder hosts(List<? extends Object> hosts)

Required for environment resource creation.

Parameters:

hosts - Required for environment resource creation. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-hosts

initialVlans

@Stability(Stable)
public CfnEnvironment.Builder initialVlans(IResolvable initialVlans)

Amazon EVS is in public preview release and is subject to change.

The initial VLAN subnets for the environment. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.

Required for environment resource creation.

Parameters:

initialVlans -

Amazon EVS is in public preview release and is subject to change.

This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-initialvlans

initialVlans

@Stability(Stable)
public CfnEnvironment.Builder initialVlans(CfnEnvironment.InitialVlansProperty initialVlans)

Amazon EVS is in public preview release and is subject to change.

The initial VLAN subnets for the environment. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.

Required for environment resource creation.

Parameters:

initialVlans -

Amazon EVS is in public preview release and is subject to change.

This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-initialvlans

kmsKeyId

@Stability(Stable)
public CfnEnvironment.Builder kmsKeyId(String kmsKeyId)

The AWS KMS key ID that AWS 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 AWS Secrets Manager managed key aws/secretsmanager . You can also specify a customer managed key.

Parameters:

kmsKeyId - The AWS KMS key ID that AWS Secrets Manager uses to encrypt secrets that are associated with the environment. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-kmskeyid

serviceAccessSecurityGroups

@Stability(Stable)
public CfnEnvironment.Builder serviceAccessSecurityGroups(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-serviceaccesssecuritygroups

serviceAccessSecurityGroups

@Stability(Stable)
public CfnEnvironment.Builder serviceAccessSecurityGroups(CfnEnvironment.ServiceAccessSecurityGroupsProperty 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-serviceaccesssecuritygroups

tags

@Stability(Stable)
public CfnEnvironment.Builder tags(List<? extends CfnTag> 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 AWS resources.

Parameters:

tags - Metadata that assists with categorization and organization. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-tags

build

@Stability(Stable)
public CfnEnvironment build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnEnvironment>

Returns:

a newly built instance of CfnEnvironment.