Class: Aws::Evs::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb

Overview

An API client for Evs. To construct a client, you need to configure a :region and :credentials.

client = Aws::Evs::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Evs::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::Evs::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



483
484
485
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 483

def initialize(*args)
  super
end

Instance Method Details

#create_environment(params = {}) ⇒ Types::CreateEnvironmentResponse

Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.

During environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF.

It can take several hours to create an environment. After the deployment completes, you can configure VCF according to your unique requirements.

You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironment action. This results in a ValidationException response.

EC2 instances created through Amazon EVS do not support associating an IAM instance profile.

Examples:

Request syntax with placeholder values


resp = client.create_environment({
  client_token: "ClientToken",
  environment_name: "EnvironmentName",
  kms_key_id: "String",
  tags: {
    "TagKey" => "TagValue",
  },
  service_access_security_groups: {
    security_groups: ["SecurityGroupId"],
  },
  vpc_id: "VpcId", # required
  service_access_subnet_id: "SubnetId", # required
  vcf_version: "VCF-5.2.1", # required, accepts VCF-5.2.1
  terms_accepted: false, # required
  license_info: [ # required
    {
      solution_key: "SolutionKey", # required
      vsan_key: "VSanLicenseKey", # required
    },
  ],
  initial_vlans: { # required
    vmk_management: { # required
      cidr: "Cidr", # required
    },
    vm_management: { # required
      cidr: "Cidr", # required
    },
    v_motion: { # required
      cidr: "Cidr", # required
    },
    v_san: { # required
      cidr: "Cidr", # required
    },
    v_tep: { # required
      cidr: "Cidr", # required
    },
    edge_v_tep: { # required
      cidr: "Cidr", # required
    },
    nsx_uplink: { # required
      cidr: "Cidr", # required
    },
    hcx: { # required
      cidr: "Cidr", # required
    },
    expansion_vlan_1: { # required
      cidr: "Cidr", # required
    },
    expansion_vlan_2: { # required
      cidr: "Cidr", # required
    },
  },
  hosts: [ # required
    {
      host_name: "HostName", # required
      key_name: "KeyName", # required
      instance_type: "i4i.metal", # required, accepts i4i.metal
      placement_group_id: "PlacementGroupId",
      dedicated_host_id: "DedicatedHostId",
    },
  ],
  connectivity_info: { # required
    private_route_server_peerings: ["RouteServerPeering"], # required
  },
  vcf_hostnames: { # required
    v_center: "HostName", # required
    nsx: "HostName", # required
    nsx_manager_1: "HostName", # required
    nsx_manager_2: "HostName", # required
    nsx_manager_3: "HostName", # required
    nsx_edge_1: "HostName", # required
    nsx_edge_2: "HostName", # required
    sddc_manager: "HostName", # required
    cloud_builder: "HostName", # required
  },
  site_id: "String", # required
})

Response structure


resp.environment.environment_id #=> String
resp.environment.environment_state #=> String, one of "CREATING", "CREATED", "DELETING", "DELETED", "CREATE_FAILED"
resp.environment.state_details #=> String
resp.environment.created_at #=> Time
resp.environment.modified_at #=> Time
resp.environment.environment_arn #=> String
resp.environment.environment_name #=> String
resp.environment.vpc_id #=> String
resp.environment.service_access_subnet_id #=> String
resp.environment.vcf_version #=> String, one of "VCF-5.2.1"
resp.environment.terms_accepted #=> Boolean
resp.environment.license_info #=> Array
resp.environment.license_info[0].solution_key #=> String
resp.environment.license_info[0].vsan_key #=> String
resp.environment.site_id #=> String
resp.environment.environment_status #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.environment.checks #=> Array
resp.environment.checks[0].type #=> String, one of "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "HOST_COUNT"
resp.environment.checks[0].result #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.environment.checks[0].impaired_since #=> Time
resp.environment.connectivity_info.private_route_server_peerings #=> Array
resp.environment.connectivity_info.private_route_server_peerings[0] #=> String
resp.environment.vcf_hostnames.v_center #=> String
resp.environment.vcf_hostnames.nsx #=> String
resp.environment.vcf_hostnames.nsx_manager_1 #=> String
resp.environment.vcf_hostnames.nsx_manager_2 #=> String
resp.environment.vcf_hostnames.nsx_manager_3 #=> String
resp.environment.vcf_hostnames.nsx_edge_1 #=> String
resp.environment.vcf_hostnames.nsx_edge_2 #=> String
resp.environment.vcf_hostnames.sddc_manager #=> String
resp.environment.vcf_hostnames.cloud_builder #=> String
resp.environment.kms_key_id #=> String
resp.environment.service_access_security_groups.security_groups #=> Array
resp.environment.service_access_security_groups.security_groups[0] #=> String
resp.environment.credentials #=> Array
resp.environment.credentials[0].secret_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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.**

  • :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.

  • :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.

  • :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.

  • :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.

  • :vpc_id (required, String) —

    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.

  • :service_access_subnet_id (required, 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.

  • :vcf_version (required, String) —

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

  • :terms_accepted (required, Boolean) —

    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.

  • :license_info (required, 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. 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.

  • :initial_vlans (required, Types::InitialVlans) —

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

  • :hosts (required, 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 key, and EC2 instance type. Optionally, you can also provide a partition or cluster placement group to use, or use Amazon EC2 Dedicated Hosts.

  • :connectivity_info (required, 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, providing BGP dynamic routing for overlay networks.

  • :vcf_hostnames (required, 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.

  • :site_id (required, 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:

See Also:



770
771
772
773
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 770

def create_environment(params = {}, options = {})
  req = build_request(:create_environment, params)
  req.send_request(options)
end

#create_environment_host(params = {}) ⇒ Types::CreateEnvironmentHostResponse

Creates an ESXi host and adds it to an Amazon EVS environment. Amazon EVS supports 4-16 hosts per environment.

This action can only be used after the Amazon EVS environment is deployed. All Amazon EVS hosts are created with the latest AMI release version for the respective VCF version of the environment.

You can use the dedicatedHostId parameter to specify an Amazon EC2 Dedicated Host for ESXi host creation.

You can use the placementGroupId parameter to specify a cluster or partition placement group to launch EC2 instances into.

You cannot use the dedicatedHostId and placementGroupId parameters together in the same CreateEnvironmentHost action. This results in a ValidationException response.

EC2 instances created through Amazon EVS do not support associating an IAM instance profile.

Examples:

Request syntax with placeholder values


resp = client.create_environment_host({
  client_token: "ClientToken",
  environment_id: "EnvironmentId", # required
  host: { # required
    host_name: "HostName", # required
    key_name: "KeyName", # required
    instance_type: "i4i.metal", # required, accepts i4i.metal
    placement_group_id: "PlacementGroupId",
    dedicated_host_id: "DedicatedHostId",
  },
})

Response structure


resp.environment_summary.environment_id #=> String
resp.environment_summary.environment_name #=> String
resp.environment_summary.vcf_version #=> String, one of "VCF-5.2.1"
resp.environment_summary.environment_status #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.environment_summary.environment_state #=> String, one of "CREATING", "CREATED", "DELETING", "DELETED", "CREATE_FAILED"
resp.environment_summary.created_at #=> Time
resp.environment_summary.modified_at #=> Time
resp.environment_summary.environment_arn #=> String
resp.host.host_name #=> String
resp.host.ip_address #=> String
resp.host.key_name #=> String
resp.host.instance_type #=> String, one of "i4i.metal"
resp.host.placement_group_id #=> String
resp.host.dedicated_host_id #=> String
resp.host.created_at #=> Time
resp.host.modified_at #=> Time
resp.host.host_state #=> String, one of "CREATING", "CREATED", "UPDATING", "DELETING", "DELETED", "CREATE_FAILED", "UPDATE_FAILED"
resp.host.state_details #=> String
resp.host.ec2_instance_id #=> String
resp.host.network_interfaces #=> Array
resp.host.network_interfaces[0].network_interface_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 host 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.**

  • :environment_id (required, String) —

    A unique ID for the environment that the host is added to.

  • :host (required, Types::HostInfoForCreate) —

    The host that is created and added to the environment.

Returns:

See Also:



867
868
869
870
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 867

def create_environment_host(params = {}, options = {})
  req = build_request(:create_environment_host, params)
  req.send_request(options)
end

#delete_environment(params = {}) ⇒ Types::DeleteEnvironmentResponse

Deletes an Amazon EVS environment.

Amazon EVS environments will only be enabled for deletion once the hosts are deleted. You can delete hosts using the DeleteEnvironmentHost action.

Environment deletion also deletes the associated Amazon EVS VLAN subnets. Other associated Amazon Web Services resources are not deleted. These resources may continue to incur costs.

Examples:

Request syntax with placeholder values


resp = client.delete_environment({
  client_token: "ClientToken",
  environment_id: "EnvironmentId", # required
})

Response structure


resp.environment.environment_id #=> String
resp.environment.environment_state #=> String, one of "CREATING", "CREATED", "DELETING", "DELETED", "CREATE_FAILED"
resp.environment.state_details #=> String
resp.environment.created_at #=> Time
resp.environment.modified_at #=> Time
resp.environment.environment_arn #=> String
resp.environment.environment_name #=> String
resp.environment.vpc_id #=> String
resp.environment.service_access_subnet_id #=> String
resp.environment.vcf_version #=> String, one of "VCF-5.2.1"
resp.environment.terms_accepted #=> Boolean
resp.environment.license_info #=> Array
resp.environment.license_info[0].solution_key #=> String
resp.environment.license_info[0].vsan_key #=> String
resp.environment.site_id #=> String
resp.environment.environment_status #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.environment.checks #=> Array
resp.environment.checks[0].type #=> String, one of "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "HOST_COUNT"
resp.environment.checks[0].result #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.environment.checks[0].impaired_since #=> Time
resp.environment.connectivity_info.private_route_server_peerings #=> Array
resp.environment.connectivity_info.private_route_server_peerings[0] #=> String
resp.environment.vcf_hostnames.v_center #=> String
resp.environment.vcf_hostnames.nsx #=> String
resp.environment.vcf_hostnames.nsx_manager_1 #=> String
resp.environment.vcf_hostnames.nsx_manager_2 #=> String
resp.environment.vcf_hostnames.nsx_manager_3 #=> String
resp.environment.vcf_hostnames.nsx_edge_1 #=> String
resp.environment.vcf_hostnames.nsx_edge_2 #=> String
resp.environment.vcf_hostnames.sddc_manager #=> String
resp.environment.vcf_hostnames.cloud_builder #=> String
resp.environment.kms_key_id #=> String
resp.environment.service_access_security_groups.security_groups #=> Array
resp.environment.service_access_security_groups.security_groups[0] #=> String
resp.environment.credentials #=> Array
resp.environment.credentials[0].secret_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 deletion 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.**

  • :environment_id (required, String) —

    A unique ID associated with the environment to be deleted.

Returns:

See Also:



954
955
956
957
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 954

def delete_environment(params = {}, options = {})
  req = build_request(:delete_environment, params)
  req.send_request(options)
end

#delete_environment_host(params = {}) ⇒ Types::DeleteEnvironmentHostResponse

Deletes a host from an Amazon EVS environment.

Before deleting a host, you must unassign and decommission the host from within the SDDC Manager user interface. Not doing so could impact the availability of your virtual machines or result in data loss.

Examples:

Request syntax with placeholder values


resp = client.delete_environment_host({
  client_token: "ClientToken",
  environment_id: "EnvironmentId", # required
  host_name: "HostName", # required
})

Response structure


resp.environment_summary.environment_id #=> String
resp.environment_summary.environment_name #=> String
resp.environment_summary.vcf_version #=> String, one of "VCF-5.2.1"
resp.environment_summary.environment_status #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.environment_summary.environment_state #=> String, one of "CREATING", "CREATED", "DELETING", "DELETED", "CREATE_FAILED"
resp.environment_summary.created_at #=> Time
resp.environment_summary.modified_at #=> Time
resp.environment_summary.environment_arn #=> String
resp.host.host_name #=> String
resp.host.ip_address #=> String
resp.host.key_name #=> String
resp.host.instance_type #=> String, one of "i4i.metal"
resp.host.placement_group_id #=> String
resp.host.dedicated_host_id #=> String
resp.host.created_at #=> Time
resp.host.modified_at #=> Time
resp.host.host_state #=> String, one of "CREATING", "CREATED", "UPDATING", "DELETING", "DELETED", "CREATE_FAILED", "UPDATE_FAILED"
resp.host.state_details #=> String
resp.host.ec2_instance_id #=> String
resp.host.network_interfaces #=> Array
resp.host.network_interfaces[0].network_interface_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :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 host deletion 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.**

  • :environment_id (required, String) —

    A unique ID for the host's environment.

  • :host_name (required, String) —

    The DNS hostname associated with the host to be deleted.

Returns:

See Also:



1029
1030
1031
1032
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1029

def delete_environment_host(params = {}, options = {})
  req = build_request(:delete_environment_host, params)
  req.send_request(options)
end

#get_environment(params = {}) ⇒ Types::GetEnvironmentResponse

Returns a description of the specified environment.

Examples:

Request syntax with placeholder values


resp = client.get_environment({
  environment_id: "EnvironmentId", # required
})

Response structure


resp.environment.environment_id #=> String
resp.environment.environment_state #=> String, one of "CREATING", "CREATED", "DELETING", "DELETED", "CREATE_FAILED"
resp.environment.state_details #=> String
resp.environment.created_at #=> Time
resp.environment.modified_at #=> Time
resp.environment.environment_arn #=> String
resp.environment.environment_name #=> String
resp.environment.vpc_id #=> String
resp.environment.service_access_subnet_id #=> String
resp.environment.vcf_version #=> String, one of "VCF-5.2.1"
resp.environment.terms_accepted #=> Boolean
resp.environment.license_info #=> Array
resp.environment.license_info[0].solution_key #=> String
resp.environment.license_info[0].vsan_key #=> String
resp.environment.site_id #=> String
resp.environment.environment_status #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.environment.checks #=> Array
resp.environment.checks[0].type #=> String, one of "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "HOST_COUNT"
resp.environment.checks[0].result #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.environment.checks[0].impaired_since #=> Time
resp.environment.connectivity_info.private_route_server_peerings #=> Array
resp.environment.connectivity_info.private_route_server_peerings[0] #=> String
resp.environment.vcf_hostnames.v_center #=> String
resp.environment.vcf_hostnames.nsx #=> String
resp.environment.vcf_hostnames.nsx_manager_1 #=> String
resp.environment.vcf_hostnames.nsx_manager_2 #=> String
resp.environment.vcf_hostnames.nsx_manager_3 #=> String
resp.environment.vcf_hostnames.nsx_edge_1 #=> String
resp.environment.vcf_hostnames.nsx_edge_2 #=> String
resp.environment.vcf_hostnames.sddc_manager #=> String
resp.environment.vcf_hostnames.cloud_builder #=> String
resp.environment.kms_key_id #=> String
resp.environment.service_access_security_groups.security_groups #=> Array
resp.environment.service_access_security_groups.security_groups[0] #=> String
resp.environment.credentials #=> Array
resp.environment.credentials[0].secret_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :environment_id (required, String) —

    A unique ID for the environment.

Returns:

See Also:



1092
1093
1094
1095
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1092

def get_environment(params = {}, options = {})
  req = build_request(:get_environment, params)
  req.send_request(options)
end

#list_environment_hosts(params = {}) ⇒ Types::ListEnvironmentHostsResponse

List the hosts within an environment.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_environment_hosts({
  next_token: "PaginationToken",
  max_results: 1,
  environment_id: "EnvironmentId", # required
})

Response structure


resp.next_token #=> String
resp.environment_hosts #=> Array
resp.environment_hosts[0].host_name #=> String
resp.environment_hosts[0].ip_address #=> String
resp.environment_hosts[0].key_name #=> String
resp.environment_hosts[0].instance_type #=> String, one of "i4i.metal"
resp.environment_hosts[0].placement_group_id #=> String
resp.environment_hosts[0].dedicated_host_id #=> String
resp.environment_hosts[0].created_at #=> Time
resp.environment_hosts[0].modified_at #=> Time
resp.environment_hosts[0].host_state #=> String, one of "CREATING", "CREATED", "UPDATING", "DELETING", "DELETED", "CREATE_FAILED", "UPDATE_FAILED"
resp.environment_hosts[0].state_details #=> String
resp.environment_hosts[0].ec2_instance_id #=> String
resp.environment_hosts[0].network_interfaces #=> Array
resp.environment_hosts[0].network_interfaces[0].network_interface_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • :max_results (Integer) —

    The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.

  • :environment_id (required, String) —

    A unique ID for the environment.

Returns:

See Also:



1151
1152
1153
1154
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1151

def list_environment_hosts(params = {}, options = {})
  req = build_request(:list_environment_hosts, params)
  req.send_request(options)
end

#list_environment_vlans(params = {}) ⇒ Types::ListEnvironmentVlansResponse

Lists environment VLANs that are associated with the specified environment.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_environment_vlans({
  next_token: "PaginationToken",
  max_results: 1,
  environment_id: "EnvironmentId", # required
})

Response structure


resp.next_token #=> String
resp.environment_vlans #=> Array
resp.environment_vlans[0].vlan_id #=> Integer
resp.environment_vlans[0].cidr #=> String
resp.environment_vlans[0].availability_zone #=> String
resp.environment_vlans[0].function_name #=> String
resp.environment_vlans[0].subnet_id #=> String
resp.environment_vlans[0].created_at #=> Time
resp.environment_vlans[0].modified_at #=> Time
resp.environment_vlans[0].vlan_state #=> String, one of "CREATING", "CREATED", "DELETING", "DELETED", "CREATE_FAILED"
resp.environment_vlans[0].state_details #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • :max_results (Integer) —

    The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.

  • :environment_id (required, String) —

    A unique ID for the environment.

Returns:

See Also:



1207
1208
1209
1210
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1207

def list_environment_vlans(params = {}, options = {})
  req = build_request(:list_environment_vlans, params)
  req.send_request(options)
end

#list_environments(params = {}) ⇒ Types::ListEnvironmentsResponse

Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_environments({
  next_token: "PaginationToken",
  max_results: 1,
  state: ["CREATING"], # accepts CREATING, CREATED, DELETING, DELETED, CREATE_FAILED
})

Response structure


resp.next_token #=> String
resp.environment_summaries #=> Array
resp.environment_summaries[0].environment_id #=> String
resp.environment_summaries[0].environment_name #=> String
resp.environment_summaries[0].vcf_version #=> String, one of "VCF-5.2.1"
resp.environment_summaries[0].environment_status #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.environment_summaries[0].environment_state #=> String, one of "CREATING", "CREATED", "DELETING", "DELETED", "CREATE_FAILED"
resp.environment_summaries[0].created_at #=> Time
resp.environment_summaries[0].modified_at #=> Time
resp.environment_summaries[0].environment_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    A unique pagination token for each page. If nextToken is returned, there are more results available. Make the call again using the returned token with all other arguments unchanged to retrieve the next page. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • :max_results (Integer) —

    The maximum number of results to return. If you specify MaxResults in the request, the response includes information up to the limit specified.

  • :state (Array<String>) —

    The state of an environment. Used to filter response results to return only environments with the specified environmentState.

Returns:

See Also:



1263
1264
1265
1266
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1263

def list_environments(params = {}, options = {})
  req = build_request(:list_environments, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags for an Amazon EVS resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) that identifies the resource to list tags for.

Returns:

See Also:



1293
1294
1295
1296
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1293

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Associates the specified tags to an Amazon EVS resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted. Tags that you create for Amazon EVS resources don't propagate to any other resources associated with the environment. For example, if you tag an environment with this operation, that tag doesn't automatically propagate to the VLAN subnets and hosts associated with the environment.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to add tags to.

  • :tags (required, 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 environment or Amazon Web Services resources.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1331
1332
1333
1334
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1331

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Deletes specified tags from an Amazon EVS resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to delete tags from.

  • :tag_keys (required, Array<String>) —

    The keys of the tags to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1357
1358
1359
1360
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1357

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end