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 any class that includes and implements Aws::CredentialProvider, or 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 the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :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 any class that includes and implements Aws::TokenProvider, or 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.



478
479
480
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 478

def initialize(*args)
  super
end

Instance Method Details

#associate_eip_to_vlan(params = {}) ⇒ Types::AssociateEipToVlanResponse

Associates an Elastic IP address with a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.

Examples:

Request syntax with placeholder values


resp = client.associate_eip_to_vlan({
  client_token: "ClientToken",
  environment_id: "EnvironmentId", # required
  vlan_name: "AssociateEipToVlanRequestVlanNameString", # required
  allocation_id: "AllocationId", # required
})

Response structure


resp.vlan.vlan_id #=> Integer
resp.vlan.cidr #=> String
resp.vlan.availability_zone #=> String
resp.vlan.function_name #=> String
resp.vlan.subnet_id #=> String
resp.vlan.created_at #=> Time
resp.vlan.modified_at #=> Time
resp.vlan.vlan_state #=> String, one of "CREATING", "CREATED", "DELETING", "DELETED", "CREATE_FAILED"
resp.vlan.state_details #=> String
resp.vlan.eip_associations #=> Array
resp.vlan.eip_associations[0].association_id #=> String
resp.vlan.eip_associations[0].allocation_id #=> String
resp.vlan.eip_associations[0].ip_address #=> String
resp.vlan.is_public #=> Boolean
resp.vlan.network_acl_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 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_id (required, String) —

    A unique ID for the environment containing the VLAN that the Elastic IP address associates with.

  • :vlan_name (required, String) —

    The name of the VLAN. hcx is the only accepted VLAN name at this time.

  • :allocation_id (required, String) —

    The Elastic IP address allocation ID.

Returns:

See Also:



548
549
550
551
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 548

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

#create_entitlement(params = {}) ⇒ Types::CreateEntitlementResponse

Creates a Windows Server License entitlement for virtual machines in an Amazon EVS environment using the provided vCenter Server connector. This is an asynchronous operation. Amazon EVS validates the specified virtual machines before starting usage tracking.

Examples:

Request syntax with placeholder values


resp = client.create_entitlement({
  client_token: "ClientToken",
  environment_id: "EnvironmentId", # required
  connector_id: "ConnectorId", # required
  entitlement_type: "WINDOWS_SERVER", # required, accepts WINDOWS_SERVER
  vm_ids: ["VmId"], # required
})

Response structure


resp.entitlements #=> Array
resp.entitlements[0].vm_id #=> String
resp.entitlements[0].environment_id #=> String
resp.entitlements[0].connector_id #=> String
resp.entitlements[0].vm_name #=> String
resp.entitlements[0].type #=> String, one of "WINDOWS_SERVER"
resp.entitlements[0].status #=> String, one of "CREATING", "CREATED", "DELETED", "AT_RISK", "ENTITLEMENT_REMOVED", "CREATE_FAILED"
resp.entitlements[0].last_synced_at #=> Time
resp.entitlements[0].started_at #=> Time
resp.entitlements[0].stopped_at #=> Time
resp.entitlements[0].error_detail.error_code #=> String
resp.entitlements[0].error_detail.error_message #=> 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 entitlement 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 to create the entitlement in.

  • :connector_id (required, String) —

    A unique ID for the connector associated with the entitlement.

  • :entitlement_type (required, String) —

    The type of entitlement to create.

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

    The list of VMware vSphere virtual machine managed object IDs to create entitlements for.

Returns:

See Also:



619
620
621
622
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 619

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

#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 in the vSphere user interface according to your needs.

When creating a new environment, the default ESX version for the selected VCF version will be used, you cannot choose a specific ESX version in CreateEnvironment action. When a host has been added with a specific ESX version, it can only be upgraded using vCenter Lifecycle Manager.

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

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, VCF-5.2.2
  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
    },
    is_hcx_public: false,
    hcx_network_acl_id: "NetworkAclId",
  },
  hosts: [ # required
    {
      host_name: "HostName", # required
      key_name: "KeyName", # required
      instance_type: "i4i.metal", # required, accepts i4i.metal, i7i.metal-24xl
      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", "VCF-5.2.2"
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", "VCENTER_REACHABILITY", "VCENTER_VM_SYNC", "VCENTER_VM_EVENT"
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 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 Amazon EVS subnets.

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

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

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

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

  • :hosts (required, Array<Types::HostInfoForCreate>) —

    The ESX 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.

  • :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 uplink subnet, providing BGP-based 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:



926
927
928
929
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 926

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

#create_environment_connector(params = {}) ⇒ Types::CreateEnvironmentConnectorResponse

Creates a connector for an Amazon EVS environment. A connector establishes a connection to a VCF appliance, such as vCenter, using a fully qualified domain name and an Amazon Web Services Secrets Manager secret that stores the appliance credentials.

Examples:

Request syntax with placeholder values


resp = client.create_environment_connector({
  client_token: "ClientToken",
  environment_id: "EnvironmentId", # required
  type: "VCENTER", # required, accepts VCENTER
  appliance_fqdn: "ApplianceFqdn", # required
  secret_identifier: "SecretIdentifier", # required
})

Response structure


resp.connector.environment_id #=> String
resp.connector.connector_id #=> String
resp.connector.type #=> String, one of "VCENTER"
resp.connector.appliance_fqdn #=> String
resp.connector.secret_arn #=> String
resp.connector.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETED"
resp.connector.state_details #=> String
resp.connector.status #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.connector.checks #=> Array
resp.connector.checks[0].type #=> String, one of "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "HOST_COUNT", "VCENTER_REACHABILITY", "VCENTER_VM_SYNC", "VCENTER_VM_EVENT"
resp.connector.checks[0].result #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.connector.checks[0].last_check_attempt #=> Time
resp.connector.checks[0].impaired_since #=> Time
resp.connector.created_at #=> Time
resp.connector.modified_at #=> Time

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 connector 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 to create the connector in.

  • :type (required, String) —

    The type of connector to create.

  • :appliance_fqdn (required, String) —

    The fully qualified domain name (FQDN) of the VCF appliance that the connector targets.

  • :secret_identifier (required, String) —

    The ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.

    Do not use credentials with Administrator privileges. We recommend using a service account with the minimum required permissions.

Returns:

See Also:



1004
1005
1006
1007
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1004

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

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

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

This action can only be used after the Amazon EVS environment is deployed.

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

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

If you don't specify an ESX version when adding hosts using CreateEnvironmentHost action, Amazon EVS automatically uses the default ESX version associated with your environment's VCF version. To find the default ESX version for a particular VCF version, use the GetVersions action.

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

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, i7i.metal-24xl
    placement_group_id: "PlacementGroupId",
    dedicated_host_id: "DedicatedHostId",
  },
  esx_version: "EsxVersion",
})

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", "VCF-5.2.2"
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", "i7i.metal-24xl"
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.

  • :esx_version (String) —

    The ESX version to use for the host.

Returns:

See Also:



1107
1108
1109
1110
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1107

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

#delete_entitlement(params = {}) ⇒ Types::DeleteEntitlementResponse

Deletes a Windows Server License entitlement for virtual machines in an Amazon EVS environment. Deleting an entitlement stops usage tracking for the specified virtual machines.

Examples:

Request syntax with placeholder values


resp = client.delete_entitlement({
  client_token: "ClientToken",
  environment_id: "EnvironmentId", # required
  connector_id: "ConnectorId", # required
  entitlement_type: "WINDOWS_SERVER", # required, accepts WINDOWS_SERVER
  vm_ids: ["VmId"], # required
})

Response structure


resp.entitlements #=> Array
resp.entitlements[0].vm_id #=> String
resp.entitlements[0].environment_id #=> String
resp.entitlements[0].connector_id #=> String
resp.entitlements[0].vm_name #=> String
resp.entitlements[0].type #=> String, one of "WINDOWS_SERVER"
resp.entitlements[0].status #=> String, one of "CREATING", "CREATED", "DELETED", "AT_RISK", "ENTITLEMENT_REMOVED", "CREATE_FAILED"
resp.entitlements[0].last_synced_at #=> Time
resp.entitlements[0].started_at #=> Time
resp.entitlements[0].stopped_at #=> Time
resp.entitlements[0].error_detail.error_code #=> String
resp.entitlements[0].error_detail.error_message #=> 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 entitlement 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 environment that the entitlement belongs to.

  • :connector_id (required, String) —

    A unique ID for the connector associated with the entitlement.

  • :entitlement_type (required, String) —

    The type of entitlement to delete.

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

    The list of VMware vSphere virtual machine managed object IDs to delete entitlements for.

Returns:

See Also:



1177
1178
1179
1180
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1177

def delete_entitlement(params = {}, options = {})
  req = build_request(:delete_entitlement, 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 and Amazon Web Services Secrets Manager secrets that Amazon EVS created. Amazon Web Services resources that you create 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", "VCF-5.2.2"
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", "VCENTER_REACHABILITY", "VCENTER_VM_SYNC", "VCENTER_VM_EVENT"
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:



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

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

#delete_environment_connector(params = {}) ⇒ Types::DeleteEnvironmentConnectorResponse

Deletes a connector from an Amazon EVS environment.

Before deleting a connector, you must remove all entitlements that are associated with the same vCenter.

Examples:

Request syntax with placeholder values


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

Response structure


resp.connector.environment_id #=> String
resp.connector.connector_id #=> String
resp.connector.type #=> String, one of "VCENTER"
resp.connector.appliance_fqdn #=> String
resp.connector.secret_arn #=> String
resp.connector.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETED"
resp.connector.state_details #=> String
resp.connector.status #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.connector.checks #=> Array
resp.connector.checks[0].type #=> String, one of "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "HOST_COUNT", "VCENTER_REACHABILITY", "VCENTER_VM_SYNC", "VCENTER_VM_EVENT"
resp.connector.checks[0].result #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.connector.checks[0].last_check_attempt #=> Time
resp.connector.checks[0].impaired_since #=> Time
resp.connector.created_at #=> Time
resp.connector.modified_at #=> Time
resp.environment_summary.environment_id #=> String
resp.environment_summary.environment_name #=> String
resp.environment_summary.vcf_version #=> String, one of "VCF-5.2.1", "VCF-5.2.2"
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

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 connector 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 environment that the connector belongs to.

  • :connector_id (required, String) —

    A unique ID for the connector to be deleted.

Returns:

See Also:



1341
1342
1343
1344
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1341

def delete_environment_connector(params = {}, options = {})
  req = build_request(:delete_environment_connector, 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", "VCF-5.2.2"
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", "i7i.metal-24xl"
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:



1416
1417
1418
1419
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1416

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

#disassociate_eip_from_vlan(params = {}) ⇒ Types::DisassociateEipFromVlanResponse

Disassociates an Elastic IP address from a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.

Examples:

Request syntax with placeholder values


resp = client.disassociate_eip_from_vlan({
  client_token: "ClientToken",
  environment_id: "EnvironmentId", # required
  vlan_name: "DisassociateEipFromVlanRequestVlanNameString", # required
  association_id: "AssociationId", # required
})

Response structure


resp.vlan.vlan_id #=> Integer
resp.vlan.cidr #=> String
resp.vlan.availability_zone #=> String
resp.vlan.function_name #=> String
resp.vlan.subnet_id #=> String
resp.vlan.created_at #=> Time
resp.vlan.modified_at #=> Time
resp.vlan.vlan_state #=> String, one of "CREATING", "CREATED", "DELETING", "DELETED", "CREATE_FAILED"
resp.vlan.state_details #=> String
resp.vlan.eip_associations #=> Array
resp.vlan.eip_associations[0].association_id #=> String
resp.vlan.eip_associations[0].allocation_id #=> String
resp.vlan.eip_associations[0].ip_address #=> String
resp.vlan.is_public #=> Boolean
resp.vlan.network_acl_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 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_id (required, String) —

    A unique ID for the environment containing the VLAN that the Elastic IP address disassociates from.

  • :vlan_name (required, String) —

    The name of the VLAN. hcx is the only accepted VLAN name at this time.

  • :association_id (required, String) —

    A unique ID for the Elastic IP address association.

Returns:

See Also:



1485
1486
1487
1488
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1485

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

#get_depot_url(params = {}) ⇒ Types::GetDepotUrlResponse

Returns a URL and authentication token for accessing the Amazon EVS Custom Addon depot. Configure the depot URL as a download source in vSphere Lifecycle Manager (vLCM) to sync and install the Amazon EVS Custom Addon.

The depot URL remains active until you rotate the authentication token by calling this action with rotate set to true.

Examples:

Request syntax with placeholder values


resp = client.get_depot_url({
  environment_id: "EnvironmentId", # required
  rotate: false,
})

Response structure


resp.depot_url #=> String
resp.token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :environment_id (required, String) —

    The unique ID of the Amazon EVS environment to get the depot URL for.

  • :rotate (Boolean) —

    Revokes the current authentication token and returns a new depot URL with a new token. Previously issued depot URLs will stop working within 5 minutes of rotation.

Returns:

See Also:



1527
1528
1529
1530
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1527

def get_depot_url(params = {}, options = {})
  req = build_request(:get_depot_url, 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", "VCF-5.2.2"
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", "VCENTER_REACHABILITY", "VCENTER_VM_SYNC", "VCENTER_VM_EVENT"
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:



1590
1591
1592
1593
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1590

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

#get_versions(params = {}) ⇒ Types::GetVersionsResponse

Returns information about VCF versions, ESX versions and EC2 instance types provided by Amazon EVS. For each VCF version, the response also includes the default ESX version and provided EC2 instance types.

Examples:

Response structure


resp.vcf_versions #=> Array
resp.vcf_versions[0].vcf_version #=> String, one of "VCF-5.2.1", "VCF-5.2.2"
resp.vcf_versions[0].status #=> String
resp.vcf_versions[0].default_esx_version #=> String
resp.vcf_versions[0].instance_types #=> Array
resp.vcf_versions[0].instance_types[0] #=> String, one of "i4i.metal", "i7i.metal-24xl"
resp.instance_type_esx_versions #=> Array
resp.instance_type_esx_versions[0].instance_type #=> String, one of "i4i.metal", "i7i.metal-24xl"
resp.instance_type_esx_versions[0].esx_versions #=> Array
resp.instance_type_esx_versions[0].esx_versions[0] #=> String

Parameters:

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

    ({})

Returns:

See Also:



1621
1622
1623
1624
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1621

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

#list_environment_connectors(params = {}) ⇒ Types::ListEnvironmentConnectorsResponse

Lists the connectors within an environment. Returns the status of each connector and its applicable checks, among other connector details.

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_connectors({
  next_token: "PaginationToken",
  max_results: 1,
  environment_id: "EnvironmentId", # required
})

Response structure


resp.next_token #=> String
resp.connectors #=> Array
resp.connectors[0].environment_id #=> String
resp.connectors[0].connector_id #=> String
resp.connectors[0].type #=> String, one of "VCENTER"
resp.connectors[0].appliance_fqdn #=> String
resp.connectors[0].secret_arn #=> String
resp.connectors[0].state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETED"
resp.connectors[0].state_details #=> String
resp.connectors[0].status #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.connectors[0].checks #=> Array
resp.connectors[0].checks[0].type #=> String, one of "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "HOST_COUNT", "VCENTER_REACHABILITY", "VCENTER_VM_SYNC", "VCENTER_VM_EVENT"
resp.connectors[0].checks[0].result #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.connectors[0].checks[0].last_check_attempt #=> Time
resp.connectors[0].checks[0].impaired_since #=> Time
resp.connectors[0].created_at #=> Time
resp.connectors[0].modified_at #=> Time

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:



1683
1684
1685
1686
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1683

def list_environment_connectors(params = {}, options = {})
  req = build_request(:list_environment_connectors, 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", "i7i.metal-24xl"
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:



1742
1743
1744
1745
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1742

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
resp.environment_vlans[0].eip_associations #=> Array
resp.environment_vlans[0].eip_associations[0].association_id #=> String
resp.environment_vlans[0].eip_associations[0].allocation_id #=> String
resp.environment_vlans[0].eip_associations[0].ip_address #=> String
resp.environment_vlans[0].is_public #=> Boolean
resp.environment_vlans[0].network_acl_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:



1804
1805
1806
1807
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1804

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", "VCF-5.2.2"
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:



1860
1861
1862
1863
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1860

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:



1890
1891
1892
1893
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1890

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

#list_vm_entitlements(params = {}) ⇒ Types::ListVmEntitlementsResponse

Lists the Windows Server License entitlements for virtual machines in an Amazon EVS environment. Returns existing entitlements for virtual machines associated with the specified environment and connector.

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_vm_entitlements({
  next_token: "PaginationToken",
  max_results: 1,
  environment_id: "EnvironmentId", # required
  connector_id: "ConnectorId", # required
  entitlement_type: "WINDOWS_SERVER", # required, accepts WINDOWS_SERVER
})

Response structure


resp.next_token #=> String
resp.entitlements #=> Array
resp.entitlements[0].vm_id #=> String
resp.entitlements[0].environment_id #=> String
resp.entitlements[0].connector_id #=> String
resp.entitlements[0].vm_name #=> String
resp.entitlements[0].type #=> String, one of "WINDOWS_SERVER"
resp.entitlements[0].status #=> String, one of "CREATING", "CREATED", "DELETED", "AT_RISK", "ENTITLEMENT_REMOVED", "CREATE_FAILED"
resp.entitlements[0].last_synced_at #=> Time
resp.entitlements[0].started_at #=> Time
resp.entitlements[0].stopped_at #=> Time
resp.entitlements[0].error_detail.error_code #=> String
resp.entitlements[0].error_detail.error_message #=> 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.

  • :connector_id (required, String) —

    A unique ID for the connector.

  • :entitlement_type (required, String) —

    The type of entitlement to list.

Returns:

See Also:



1957
1958
1959
1960
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1957

def list_vm_entitlements(params = {}, options = {})
  req = build_request(:list_vm_entitlements, 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:



1995
1996
1997
1998
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 1995

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:



2021
2022
2023
2024
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 2021

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

#update_environment_connector(params = {}) ⇒ Types::UpdateEnvironmentConnectorResponse

Updates a connector for an Amazon EVS environment. You can update the Amazon Web Services Secrets Manager secret ARN or the appliance FQDN to reconfigure the connector metadata.

You cannot update both the secret and the FQDN in the same request.

Examples:

Request syntax with placeholder values


resp = client.update_environment_connector({
  client_token: "ClientToken",
  environment_id: "EnvironmentId", # required
  connector_id: "ConnectorId", # required
  appliance_fqdn: "ApplianceFqdn",
  secret_identifier: "SecretIdentifier",
})

Response structure


resp.connector.environment_id #=> String
resp.connector.connector_id #=> String
resp.connector.type #=> String, one of "VCENTER"
resp.connector.appliance_fqdn #=> String
resp.connector.secret_arn #=> String
resp.connector.state #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETED"
resp.connector.state_details #=> String
resp.connector.status #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.connector.checks #=> Array
resp.connector.checks[0].type #=> String, one of "KEY_REUSE", "KEY_COVERAGE", "REACHABILITY", "HOST_COUNT", "VCENTER_REACHABILITY", "VCENTER_VM_SYNC", "VCENTER_VM_EVENT"
resp.connector.checks[0].result #=> String, one of "PASSED", "FAILED", "UNKNOWN"
resp.connector.checks[0].last_check_attempt #=> Time
resp.connector.checks[0].impaired_since #=> Time
resp.connector.created_at #=> Time
resp.connector.modified_at #=> Time

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 connector update 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 connector belongs to.

  • :connector_id (required, String) —

    A unique ID for the connector to update.

  • :appliance_fqdn (String) —

    The new fully qualified domain name (FQDN) of the VCF appliance that the connector connects to.

  • :secret_identifier (String) —

    The new ARN or name of the Amazon Web Services Secrets Manager secret that stores the credentials for the VCF appliance.

Returns:

See Also:



2099
2100
2101
2102
 
# File 'gems/aws-sdk-evs/lib/aws-sdk-evs/client.rb', line 2099

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