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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb

Overview

An object that represents an Amazon EVS environment.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#checks ⇒ Array<Types::Check>

A check on the environment to identify connector health.

Returns:



1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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:



1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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) 


1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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:



1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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) 


1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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) 


1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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) 


1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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) 


1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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) 


1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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) 


1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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 meet minimum core requirements, and the vSAN license key must meet minimum capacity requirements for your selected instance type.

For information about minimum license requirements, see the VCF subscriptions section in the Amazon EVS User Guide.

Returns:



1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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) 


1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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:



1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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) 


1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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) 


1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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) 


1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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) 


1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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:



1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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) 


1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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) 


1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/types.rb', line 1103

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