evs/aws.sdk.kotlin.services.evs/EvsClient

EvsClient

Amazon Elastic VMware Service (Amazon EVS) is a service that you can use to deploy a VMware Cloud Foundation (VCF) software environment directly on EC2 bare metal instances within an Amazon Virtual Private Cloud (VPC).

Workloads running on Amazon EVS are fully compatible with workloads running on any standard VMware vSphere environment. This means that you can migrate any VMware-based workload to Amazon EVS without workload modification.

Types

Builder

class Builder : AbstractSdkClientBuilder<EvsClient.Config, EvsClient.Config.Builder, EvsClient>

Companion

object Companion : AbstractAwsSdkClientFactory<EvsClient.Config, EvsClient.Config.Builder, EvsClient, EvsClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: EvsClient.Config

EvsClient's configuration

Functions

createEnvironment

abstract suspend fun createEnvironment(input: CreateEnvironmentRequest): CreateEnvironmentResponse

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

createEnvironmentHost

abstract suspend fun createEnvironmentHost(input: CreateEnvironmentHostRequest): CreateEnvironmentHostResponse

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

deleteEnvironment

abstract suspend fun deleteEnvironment(input: DeleteEnvironmentRequest): DeleteEnvironmentResponse

Deletes an Amazon EVS environment.

deleteEnvironmentHost

abstract suspend fun deleteEnvironmentHost(input: DeleteEnvironmentHostRequest): DeleteEnvironmentHostResponse

Deletes a host from an Amazon EVS environment.

getEnvironment

abstract suspend fun getEnvironment(input: GetEnvironmentRequest): GetEnvironmentResponse

Returns a description of the specified environment.

listEnvironmentHosts

abstract suspend fun listEnvironmentHosts(input: ListEnvironmentHostsRequest): ListEnvironmentHostsResponse

List the hosts within an environment.

listEnvironments

abstract suspend fun listEnvironments(input: ListEnvironmentsRequest = ListEnvironmentsRequest { }): ListEnvironmentsResponse

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

listEnvironmentVlans

abstract suspend fun listEnvironmentVlans(input: ListEnvironmentVlansRequest): ListEnvironmentVlansResponse

Lists environment VLANs that are associated with the specified environment.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Lists the tags for an Amazon EVS resource.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

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.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Deletes specified tags from an Amazon EVS resource.

Inherited functions

expect abstract fun close()

createEnvironment

inline suspend fun EvsClient.createEnvironment(crossinline block: CreateEnvironmentRequest.Builder.() -> Unit): CreateEnvironmentResponse

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

createEnvironmentHost

inline suspend fun EvsClient.createEnvironmentHost(crossinline block: CreateEnvironmentHostRequest.Builder.() -> Unit): CreateEnvironmentHostResponse

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

deleteEnvironment

inline suspend fun EvsClient.deleteEnvironment(crossinline block: DeleteEnvironmentRequest.Builder.() -> Unit): DeleteEnvironmentResponse

Deletes an Amazon EVS environment.

deleteEnvironmentHost

inline suspend fun EvsClient.deleteEnvironmentHost(crossinline block: DeleteEnvironmentHostRequest.Builder.() -> Unit): DeleteEnvironmentHostResponse

Deletes a host from an Amazon EVS environment.

getEnvironment

inline suspend fun EvsClient.getEnvironment(crossinline block: GetEnvironmentRequest.Builder.() -> Unit): GetEnvironmentResponse

Returns a description of the specified environment.

listEnvironmentHosts

inline suspend fun EvsClient.listEnvironmentHosts(crossinline block: ListEnvironmentHostsRequest.Builder.() -> Unit): ListEnvironmentHostsResponse

List the hosts within an environment.

listEnvironmentHostsPaginated

fun EvsClient.listEnvironmentHostsPaginated(initialRequest: ListEnvironmentHostsRequest): Flow<ListEnvironmentHostsResponse>

fun EvsClient.listEnvironmentHostsPaginated(block: ListEnvironmentHostsRequest.Builder.() -> Unit): Flow<ListEnvironmentHostsResponse>

Paginate over ListEnvironmentHostsResponse results.

listEnvironments

inline suspend fun EvsClient.listEnvironments(crossinline block: ListEnvironmentsRequest.Builder.() -> Unit): ListEnvironmentsResponse

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

listEnvironmentsPaginated

fun EvsClient.listEnvironmentsPaginated(initialRequest: ListEnvironmentsRequest = ListEnvironmentsRequest { }): Flow<ListEnvironmentsResponse>

fun EvsClient.listEnvironmentsPaginated(block: ListEnvironmentsRequest.Builder.() -> Unit): Flow<ListEnvironmentsResponse>

Paginate over ListEnvironmentsResponse results.

listEnvironmentVlans

inline suspend fun EvsClient.listEnvironmentVlans(crossinline block: ListEnvironmentVlansRequest.Builder.() -> Unit): ListEnvironmentVlansResponse

Lists environment VLANs that are associated with the specified environment.

listEnvironmentVlansPaginated

fun EvsClient.listEnvironmentVlansPaginated(initialRequest: ListEnvironmentVlansRequest): Flow<ListEnvironmentVlansResponse>

fun EvsClient.listEnvironmentVlansPaginated(block: ListEnvironmentVlansRequest.Builder.() -> Unit): Flow<ListEnvironmentVlansResponse>

Paginate over ListEnvironmentVlansResponse results.

listTagsForResource

inline suspend fun EvsClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags for an Amazon EVS resource.

tagResource

inline suspend fun EvsClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

untagResource

inline suspend fun EvsClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Deletes specified tags from an Amazon EVS resource.

withConfig

fun EvsClient.withConfig(block: EvsClient.Config.Builder.() -> Unit): EvsClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.