Class: Aws::Evs::Types::Environment

Inherits:

Struct

Object
Struct
Aws::Evs::Types::Environment

show all

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

Overview

An object that represents an Amazon EVS environment.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#checks ⇒ Array<Types::Check>
A check on the environment to identify instance health and VMware VCF licensing issues.
#connectivity_info ⇒ Types::ConnectivityInfo
The connectivity configuration for the environment.
#created_at ⇒ Time
The date and time that the environment was created.
#credentials ⇒ Array<Types::Secret>
The VCF credentials that are stored as Amazon EVS managed secrets in Amazon Web Services Secrets Manager.
#environment_arn ⇒ String
The Amazon Resource Name (ARN) that is associated with the environment.
#environment_id ⇒ String
The unique ID for the environment.
#environment_name ⇒ String
The name of the environment.
#environment_state ⇒ String
The state of an environment.
#environment_status ⇒ String
Reports impaired functionality that stems from issues internal to the environment, such as impaired reachability.
#kms_key_id ⇒ String
The Amazon Web Services KMS key ID that Amazon Web Services Secrets Manager uses to encrypt secrets that are associated with the environment.
#license_info ⇒ Array<Types::LicenseInfo>
The license information that Amazon EVS requires to create an environment.
#modified_at ⇒ Time
The date and time that the environment was modified.
#service_access_security_groups ⇒ Types::ServiceAccessSecurityGroups
The security groups that allow traffic between the Amazon EVS control plane and your VPC for service access.
#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 associated with your Amazon EVS environment.
#state_details ⇒ String
A detailed description of the environmentState of an environment.
#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 to be used by the VCF management appliances in your environment.
#vcf_version ⇒ String
The VCF version of the environment.
#vpc_id ⇒ String
The VPC associated with the environment.

Instance Attribute Details

#checks ⇒ `Array<Types::Check>`

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

Returns:

(Array<Types::Check>)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  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 uplink VLAN for connectivity to the NSX overlay network.

Returns:

(Types::ConnectivityInfo)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ `Time`

The date and time that the environment was created.

Returns:

(Time)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end

#credentials ⇒ `Array<Types::Secret>`

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:

(Array<Types::Secret>)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end

#environment_arn ⇒ `String`

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

Returns:

(String)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end

#environment_id ⇒ `String`

The unique ID for the environment.

Returns:

(String)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end

#environment_name ⇒ `String`

The name of the environment.

Returns:

(String)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end

#environment_state ⇒ `String`

The state of an environment.

Returns:

(String)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end

#environment_status ⇒ `String`

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

Returns:

(String)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ `String`

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:

(String)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  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.

Returns:

(Array<Types::LicenseInfo>)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end

#modified_at ⇒ `Time`

The date and time that the environment was modified.

Returns:

(Time)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end

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

(Types::ServiceAccessSecurityGroups)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  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 perform validations and create the environment.

Returns:

(String)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end

#site_id ⇒ `String`

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:

(String)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end

#state_details ⇒ `String`

A detailed description of the environmentState of an environment.

Returns:

(String)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  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 541

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end

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

(Types::VcfHostnames)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end

#vcf_version ⇒ `String`

The VCF version of the environment.

Returns:

(String)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ `String`

The VPC associated with the environment.

Returns:

(String)

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

class Environment < Struct.new(
  :environment_id,
  :environment_state,
  :state_details,
  :created_at,
  :modified_at,
  :environment_arn,
  :environment_name,
  :vpc_id,
  :service_access_subnet_id,
  :vcf_version,
  :terms_accepted,
  :license_info,
  :site_id,
  :environment_status,
  :checks,
  :connectivity_info,
  :vcf_hostnames,
  :kms_key_id,
  :service_access_security_groups,
  :credentials)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Evs::Types::Environment

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#checks ⇒ Array<Types::Check>

#connectivity_info ⇒ Types::ConnectivityInfo

#created_at ⇒ Time

#credentials ⇒ Array<Types::Secret>

#environment_arn ⇒ String

#environment_id ⇒ String

#environment_name ⇒ String

#environment_state ⇒ String

#environment_status ⇒ String

#kms_key_id ⇒ String

#license_info ⇒ Array<Types::LicenseInfo>

#modified_at ⇒ Time

#service_access_security_groups ⇒ Types::ServiceAccessSecurityGroups

#service_access_subnet_id ⇒ String

#site_id ⇒ String

#state_details ⇒ String

#terms_accepted ⇒ Boolean

#vcf_hostnames ⇒ Types::VcfHostnames

#vcf_version ⇒ String

#vpc_id ⇒ String

#checks ⇒ `Array<Types::Check>`

#connectivity_info ⇒ `Types::ConnectivityInfo`

#created_at ⇒ `Time`

#credentials ⇒ `Array<Types::Secret>`

#environment_arn ⇒ `String`

#environment_id ⇒ `String`

#environment_name ⇒ `String`

#environment_state ⇒ `String`

#environment_status ⇒ `String`

#kms_key_id ⇒ `String`

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

#modified_at ⇒ `Time`

#service_access_security_groups ⇒ `Types::ServiceAccessSecurityGroups`

#service_access_subnet_id ⇒ `String`

#site_id ⇒ `String`

#state_details ⇒ `String`

#terms_accepted ⇒ `Boolean`

#vcf_hostnames ⇒ `Types::VcfHostnames`

#vcf_version ⇒ `String`

#vpc_id ⇒ `String`