Class: Aws::Evs::Types::CreateEnvironmentRequest

Inherits:

Struct

Object
Struct
Aws::Evs::Types::CreateEnvironmentRequest

show all

Defined in:: gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#client_token ⇒ String
This parameter is not used in Amazon EVS currently.
#connectivity_info ⇒ Types::ConnectivityInfo
The connectivity configuration for the environment.
#environment_name ⇒ String
The name to give to your environment.
#hosts ⇒ Array<Types::HostInfoForCreate>
The ESXi hosts to add to the environment.
#initial_vlans ⇒ Types::InitialVlans
The initial VLAN subnets for the Amazon EVS environment.
#kms_key_id ⇒ String
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.
#license_info ⇒ Array<Types::LicenseInfo>
The license information that Amazon EVS requires to create an environment.
#service_access_security_groups ⇒ Types::ServiceAccessSecurityGroups
The security group that controls communication between the Amazon EVS control plane and VPC.
#service_access_subnet_id ⇒ String
The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC.
#site_id ⇒ String
The Broadcom Site ID that is allocated to you as part of your electronic software delivery.
#tags ⇒ Hash<String,String>
Metadata that assists with categorization and organization.
#terms_accepted ⇒ Boolean
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.
#vcf_hostnames ⇒ Types::VcfHostnames
The DNS hostnames for the virtual machines that host the VCF management appliances.
#vcf_version ⇒ String
The VCF version to use for the environment.
#vpc_id ⇒ String
A unique ID for the VPC that the environment is deployed inside.

Instance Attribute Details

#client_token ⇒ `String`

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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

(String)

# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 292

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :environment_name,
  :kms_key_id,
  :tags,
  :service_access_security_groups,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :initial_vlans,
  :hosts,
  :connectivity_info,
  :vcf_hostnames,
  :site_id)
  SENSITIVE = []
  include Aws::Structure
end

#connectivity_info ⇒ `Types::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 uplink subnet, providing BGP-based dynamic routing for overlay networks.

Returns:

(Types::ConnectivityInfo)

# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 292

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :environment_name,
  :kms_key_id,
  :tags,
  :service_access_security_groups,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :initial_vlans,
  :hosts,
  :connectivity_info,
  :vcf_hostnames,
  :site_id)
  SENSITIVE = []
  include Aws::Structure
end

#environment_name ⇒ `String`

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:

(String)

# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 292

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :environment_name,
  :kms_key_id,
  :tags,
  :service_access_security_groups,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :initial_vlans,
  :hosts,
  :connectivity_info,
  :vcf_hostnames,
  :site_id)
  SENSITIVE = []
  include Aws::Structure
end

#hosts ⇒ `Array<Types::HostInfoForCreate>`

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 keypair name, and EC2 instance type. Optionally, you can also provide a partition or cluster placement group to use, or use Amazon EC2 Dedicated Hosts.

Returns:

(Array<Types::HostInfoForCreate>)

# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 292

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :environment_name,
  :kms_key_id,
  :tags,
  :service_access_security_groups,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :initial_vlans,
  :hosts,
  :connectivity_info,
  :vcf_hostnames,
  :site_id)
  SENSITIVE = []
  include Aws::Structure
end

#initial_vlans ⇒ `Types::InitialVlans`

The initial VLAN subnets for the Amazon EVS environment.

For each Amazon EVS VLAN subnet, you must specify a non-overlapping CIDR block. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.

Returns:

(Types::InitialVlans)

# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 292

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :environment_name,
  :kms_key_id,
  :tags,
  :service_access_security_groups,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :initial_vlans,
  :hosts,
  :connectivity_info,
  :vcf_hostnames,
  :site_id)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

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:

(String)

# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 292

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :environment_name,
  :kms_key_id,
  :tags,
  :service_access_security_groups,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :initial_vlans,
  :hosts,
  :connectivity_info,
  :vcf_hostnames,
  :site_id)
  SENSITIVE = []
  include Aws::Structure
end

#license_info ⇒ `Array<Types::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.

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:

(Array<Types::LicenseInfo>)

# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 292

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :environment_name,
  :kms_key_id,
  :tags,
  :service_access_security_groups,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :initial_vlans,
  :hosts,
  :connectivity_info,
  :vcf_hostnames,
  :site_id)
  SENSITIVE = []
  include Aws::Structure
end

#service_access_security_groups ⇒ `Types::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:

(Types::ServiceAccessSecurityGroups)

# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 292

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :environment_name,
  :kms_key_id,
  :tags,
  :service_access_security_groups,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :initial_vlans,
  :hosts,
  :connectivity_info,
  :vcf_hostnames,
  :site_id)
  SENSITIVE = []
  include Aws::Structure
end

#service_access_subnet_id ⇒ `String`

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:

(String)

# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 292

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :environment_name,
  :kms_key_id,
  :tags,
  :service_access_security_groups,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :initial_vlans,
  :hosts,
  :connectivity_info,
  :vcf_hostnames,
  :site_id)
  SENSITIVE = []
  include Aws::Structure
end

#site_id ⇒ `String`

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:

(String)

# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 292

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :environment_name,
  :kms_key_id,
  :tags,
  :service_access_security_groups,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :initial_vlans,
  :hosts,
  :connectivity_info,
  :vcf_hostnames,
  :site_id)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

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:

(Hash<String,String>)

# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 292

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :environment_name,
  :kms_key_id,
  :tags,
  :service_access_security_groups,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :initial_vlans,
  :hosts,
  :connectivity_info,
  :vcf_hostnames,
  :site_id)
  SENSITIVE = []
  include Aws::Structure
end

#terms_accepted ⇒ `Boolean`

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:

(Boolean)

# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 292

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :environment_name,
  :kms_key_id,
  :tags,
  :service_access_security_groups,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :initial_vlans,
  :hosts,
  :connectivity_info,
  :vcf_hostnames,
  :site_id)
  SENSITIVE = []
  include Aws::Structure
end

#vcf_hostnames ⇒ `Types::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:

(Types::VcfHostnames)

# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 292

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :environment_name,
  :kms_key_id,
  :tags,
  :service_access_security_groups,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :initial_vlans,
  :hosts,
  :connectivity_info,
  :vcf_hostnames,
  :site_id)
  SENSITIVE = []
  include Aws::Structure
end

#vcf_version ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 292

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :environment_name,
  :kms_key_id,
  :tags,
  :service_access_security_groups,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :initial_vlans,
  :hosts,
  :connectivity_info,
  :vcf_hostnames,
  :site_id)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ `String`

A unique ID for the VPC that the environment is deployed inside.

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 specify 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. The VPC cannot be used with any other deployed Amazon EVS environment. Amazon EVS does not provide multi-VPC support for environments at this time.

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.

Ensure that you specify a VPC that is adequately sized to accommodate the evws subnets.

Returns:

(String)

# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 292

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :environment_name,
  :kms_key_id,
  :tags,
  :service_access_security_groups,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :initial_vlans,
  :hosts,
  :connectivity_info,
  :vcf_hostnames,
  :site_id)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Evs::Types::CreateEnvironmentRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

#connectivity_info ⇒ Types::ConnectivityInfo

#environment_name ⇒ String

#hosts ⇒ Array<Types::HostInfoForCreate>

#initial_vlans ⇒ Types::InitialVlans

#kms_key_id ⇒ String

#license_info ⇒ Array<Types::LicenseInfo>

#service_access_security_groups ⇒ Types::ServiceAccessSecurityGroups

#service_access_subnet_id ⇒ String

#site_id ⇒ String

#tags ⇒ Hash<String,String>

#terms_accepted ⇒ Boolean

#vcf_hostnames ⇒ Types::VcfHostnames

#vcf_version ⇒ String

#vpc_id ⇒ String

#client_token ⇒ `String`

#connectivity_info ⇒ `Types::ConnectivityInfo`

#environment_name ⇒ `String`

#hosts ⇒ `Array<Types::HostInfoForCreate>`

#initial_vlans ⇒ `Types::InitialVlans`

#kms_key_id ⇒ `String`

#license_info ⇒ `Array<Types::LicenseInfo>`

#service_access_security_groups ⇒ `Types::ServiceAccessSecurityGroups`

#service_access_subnet_id ⇒ `String`

#site_id ⇒ `String`

#tags ⇒ `Hash<String,String>`

#terms_accepted ⇒ `Boolean`

#vcf_hostnames ⇒ `Types::VcfHostnames`

#vcf_version ⇒ `String`

#vpc_id ⇒ `String`