Documentation
¶
Overview ¶
Package evs provides the API client, operations, and parameter types for Amazon Elastic VMware Service.
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.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AssociateEipToVlanInput
- type AssociateEipToVlanOutput
- type AuthResolverParameters
- type AuthSchemeResolver
- type Client
- func (c *Client) AssociateEipToVlan(ctx context.Context, params *AssociateEipToVlanInput, optFns ...func(*Options)) (*AssociateEipToVlanOutput, error)
- func (c *Client) CreateEnvironment(ctx context.Context, params *CreateEnvironmentInput, optFns ...func(*Options)) (*CreateEnvironmentOutput, error)
- func (c *Client) CreateEnvironmentHost(ctx context.Context, params *CreateEnvironmentHostInput, ...) (*CreateEnvironmentHostOutput, error)
- func (c *Client) DeleteEnvironment(ctx context.Context, params *DeleteEnvironmentInput, optFns ...func(*Options)) (*DeleteEnvironmentOutput, error)
- func (c *Client) DeleteEnvironmentHost(ctx context.Context, params *DeleteEnvironmentHostInput, ...) (*DeleteEnvironmentHostOutput, error)
- func (c *Client) DisassociateEipFromVlan(ctx context.Context, params *DisassociateEipFromVlanInput, ...) (*DisassociateEipFromVlanOutput, error)
- func (c *Client) GetEnvironment(ctx context.Context, params *GetEnvironmentInput, optFns ...func(*Options)) (*GetEnvironmentOutput, error)
- func (c *Client) GetVersions(ctx context.Context, params *GetVersionsInput, optFns ...func(*Options)) (*GetVersionsOutput, error)
- func (c *Client) ListEnvironmentHosts(ctx context.Context, params *ListEnvironmentHostsInput, ...) (*ListEnvironmentHostsOutput, error)
- func (c *Client) ListEnvironmentVlans(ctx context.Context, params *ListEnvironmentVlansInput, ...) (*ListEnvironmentVlansOutput, error)
- func (c *Client) ListEnvironments(ctx context.Context, params *ListEnvironmentsInput, optFns ...func(*Options)) (*ListEnvironmentsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) Options() Options
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- type CreateEnvironmentHostInput
- type CreateEnvironmentHostOutput
- type CreateEnvironmentInput
- type CreateEnvironmentOutput
- type DeleteEnvironmentHostInput
- type DeleteEnvironmentHostOutput
- type DeleteEnvironmentInput
- type DeleteEnvironmentOutput
- type DisassociateEipFromVlanInput
- type DisassociateEipFromVlanOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type GetEnvironmentInput
- type GetEnvironmentOutput
- type GetVersionsInput
- type GetVersionsOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListEnvironmentHostsAPIClient
- type ListEnvironmentHostsInput
- type ListEnvironmentHostsOutput
- type ListEnvironmentHostsPaginator
- type ListEnvironmentHostsPaginatorOptions
- type ListEnvironmentVlansAPIClient
- type ListEnvironmentVlansInput
- type ListEnvironmentVlansOutput
- type ListEnvironmentVlansPaginator
- type ListEnvironmentVlansPaginatorOptions
- type ListEnvironmentsAPIClient
- type ListEnvironmentsInput
- type ListEnvironmentsOutput
- type ListEnvironmentsPaginator
- type ListEnvironmentsPaginatorOptions
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type Options
- type ResolveEndpoint
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
Constants ¶
const ServiceAPIVersion = "2023-07-27"
const ServiceID = "evs"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
Types ¶
type AssociateEipToVlanInput ¶ added in v1.5.0
type AssociateEipToVlanInput struct {
// The Elastic IP address allocation ID.
//
// This member is required.
AllocationId *string
// A unique ID for the environment containing the VLAN that the Elastic IP address
// associates with.
//
// This member is required.
EnvironmentId *string
// The name of the VLAN. hcx is the only accepted VLAN name at this time.
//
// This member is required.
VlanName *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.
ClientToken *string
// contains filtered or unexported fields
}
type AssociateEipToVlanOutput ¶ added in v1.5.0
type AssociateEipToVlanOutput struct {
// The VLANs that Amazon EVS creates during environment creation.
Vlan *types.Vlan
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type AuthResolverParameters ¶
type AuthResolverParameters struct {
// The name of the operation being invoked.
Operation string
// The region in which the operation is being invoked.
Region string
}
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon Elastic VMware Service.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AssociateEipToVlan ¶ added in v1.5.0
func (c *Client) AssociateEipToVlan(ctx context.Context, params *AssociateEipToVlanInput, optFns ...func(*Options)) (*AssociateEipToVlanOutput, error)
Associates an Elastic IP address with a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.
func (*Client) CreateEnvironment ¶
func (c *Client) CreateEnvironment(ctx context.Context, params *CreateEnvironmentInput, optFns ...func(*Options)) (*CreateEnvironmentOutput, error)
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.
func (*Client) CreateEnvironmentHost ¶
func (c *Client) CreateEnvironmentHost(ctx context.Context, params *CreateEnvironmentHostInput, optFns ...func(*Options)) (*CreateEnvironmentHostOutput, error)
Creates an ESX 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.
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.
func (*Client) DeleteEnvironment ¶
func (c *Client) DeleteEnvironment(ctx context.Context, params *DeleteEnvironmentInput, optFns ...func(*Options)) (*DeleteEnvironmentOutput, error)
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.
func (*Client) DeleteEnvironmentHost ¶
func (c *Client) DeleteEnvironmentHost(ctx context.Context, params *DeleteEnvironmentHostInput, optFns ...func(*Options)) (*DeleteEnvironmentHostOutput, error)
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.
func (*Client) DisassociateEipFromVlan ¶ added in v1.5.0
func (c *Client) DisassociateEipFromVlan(ctx context.Context, params *DisassociateEipFromVlanInput, optFns ...func(*Options)) (*DisassociateEipFromVlanOutput, error)
Disassociates an Elastic IP address from a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.
func (*Client) GetEnvironment ¶
func (c *Client) GetEnvironment(ctx context.Context, params *GetEnvironmentInput, optFns ...func(*Options)) (*GetEnvironmentOutput, error)
Returns a description of the specified environment.
func (*Client) GetVersions ¶ added in v1.6.0
func (c *Client) GetVersions(ctx context.Context, params *GetVersionsInput, optFns ...func(*Options)) (*GetVersionsOutput, error)
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.
func (*Client) ListEnvironmentHosts ¶
func (c *Client) ListEnvironmentHosts(ctx context.Context, params *ListEnvironmentHostsInput, optFns ...func(*Options)) (*ListEnvironmentHostsOutput, error)
List the hosts within an environment.
func (*Client) ListEnvironmentVlans ¶
func (c *Client) ListEnvironmentVlans(ctx context.Context, params *ListEnvironmentVlansInput, optFns ...func(*Options)) (*ListEnvironmentVlansOutput, error)
Lists environment VLANs that are associated with the specified environment.
func (*Client) ListEnvironments ¶
func (c *Client) ListEnvironments(ctx context.Context, params *ListEnvironmentsInput, optFns ...func(*Options)) (*ListEnvironmentsOutput, error)
Lists the Amazon EVS environments in your Amazon Web Services account in the specified Amazon Web Services Region.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists the tags for an Amazon EVS resource.
func (*Client) Options ¶
Options returns a copy of the client configuration.
Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
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.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Deletes specified tags from an Amazon EVS resource.
type CreateEnvironmentHostInput ¶
type CreateEnvironmentHostInput struct {
// A unique ID for the environment that the host is added to.
//
// This member is required.
EnvironmentId *string
// The host that is created and added to the environment.
//
// This member is required.
Host *types.HostInfoForCreate
// 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.
ClientToken *string
// The ESX version to use for the host.
EsxVersion *string
// contains filtered or unexported fields
}
type CreateEnvironmentHostOutput ¶
type CreateEnvironmentHostOutput struct {
// A summary of the environment that the host is created in.
EnvironmentSummary *types.EnvironmentSummary
// A description of the created host.
Host *types.Host
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type CreateEnvironmentInput ¶
type CreateEnvironmentInput struct {
// 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.
//
// This member is required.
ConnectivityInfo *types.ConnectivityInfo
// 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.
//
// This member is required.
Hosts []types.HostInfoForCreate
// 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.
//
// This member is required.
InitialVlans *types.InitialVlans
// The license information that Amazon EVS requires to create an environment.
// Amazon EVS requires two license keys: a VCF solution key and a vSAN license key.
// The VCF solution key must cover a minimum of 256 cores. The vSAN license key
// must provide at least 110 TiB of vSAN capacity.
//
// 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.
//
// This member is required.
LicenseInfo []types.LicenseInfo
// 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.
//
// This member is required.
ServiceAccessSubnetId *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.
//
// This member is required.
SiteId *string
// 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.
//
// This member is required.
TermsAccepted *bool
// 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.
//
// This member is required.
VcfHostnames *types.VcfHostnames
// The VCF version to use for the environment.
//
// This member is required.
VcfVersion types.VcfVersion
// 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.
//
// This member is required.
VpcId *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.
ClientToken *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.
EnvironmentName *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.
KmsKeyId *string
// 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.
ServiceAccessSecurityGroups *types.ServiceAccessSecurityGroups
// 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.
Tags map[string]string
// contains filtered or unexported fields
}
type CreateEnvironmentOutput ¶
type CreateEnvironmentOutput struct {
// A description of the created environment.
Environment *types.Environment
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type DeleteEnvironmentHostInput ¶
type DeleteEnvironmentHostInput struct {
// A unique ID for the host's environment.
//
// This member is required.
EnvironmentId *string
// The DNS hostname associated with the host to be deleted.
//
// This member is required.
HostName *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.
ClientToken *string
// contains filtered or unexported fields
}
type DeleteEnvironmentHostOutput ¶
type DeleteEnvironmentHostOutput struct {
// A summary of the environment that the host was deleted from.
EnvironmentSummary *types.EnvironmentSummary
// A description of the deleted host.
Host *types.Host
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type DeleteEnvironmentInput ¶
type DeleteEnvironmentInput struct {
// A unique ID associated with the environment to be deleted.
//
// This member is required.
EnvironmentId *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.
ClientToken *string
// contains filtered or unexported fields
}
type DeleteEnvironmentOutput ¶
type DeleteEnvironmentOutput struct {
// A description of the deleted environment.
Environment *types.Environment
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type DisassociateEipFromVlanInput ¶ added in v1.5.0
type DisassociateEipFromVlanInput struct {
// A unique ID for the Elastic IP address association.
//
// This member is required.
AssociationId *string
// A unique ID for the environment containing the VLAN that the Elastic IP address
// disassociates from.
//
// This member is required.
EnvironmentId *string
// The name of the VLAN. hcx is the only accepted VLAN name at this time.
//
// This member is required.
VlanName *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.
ClientToken *string
// contains filtered or unexported fields
}
type DisassociateEipFromVlanOutput ¶ added in v1.5.0
type DisassociateEipFromVlanOutput struct {
// The VLANs that Amazon EVS creates during environment creation.
Vlan *types.Vlan
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type EndpointParameters ¶
type EndpointParameters struct {
// The AWS region used to dispatch the request.
//
// Parameter is
// required.
//
// AWS::Region
Region *string
// When true, use the dual-stack endpoint. If the configured endpoint does not
// support dual-stack, dispatching the request MAY return an error.
//
// Defaults to
// false if no value is provided.
//
// AWS::UseDualStack
UseDualStack *bool
// When true, send this request to the FIPS-compliant regional endpoint. If the
// configured endpoint does not have a FIPS compliant endpoint, dispatching the
// request will return an error.
//
// Defaults to false if no value is
// provided.
//
// AWS::UseFIPS
UseFIPS *bool
// Override the endpoint used to send this request
//
// Parameter is
// required.
//
// SDK::Endpoint
Endpoint *string
}
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶
type EndpointResolverV2 interface {
// ResolveEndpoint attempts to resolve the endpoint with the provided options,
// returning the endpoint if found. Otherwise an error is returned.
ResolveEndpoint(ctx context.Context, params EndpointParameters) (
smithyendpoints.Endpoint, error,
)
}
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶
func NewDefaultEndpointResolverV2() EndpointResolverV2
type GetEnvironmentInput ¶
type GetEnvironmentInput struct {
// A unique ID for the environment.
//
// This member is required.
EnvironmentId *string
// contains filtered or unexported fields
}
type GetEnvironmentOutput ¶
type GetEnvironmentOutput struct {
// A description of the requested environment.
Environment *types.Environment
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type GetVersionsInput ¶ added in v1.6.0
type GetVersionsInput struct {
// contains filtered or unexported fields
}
type GetVersionsOutput ¶ added in v1.6.0
type GetVersionsOutput struct {
// A list of EC2 instance types and their available ESX versions.
//
// This member is required.
InstanceTypeEsxVersions []types.InstanceTypeEsxVersionsInfo
// A list of VCF versions with their availability status, default ESX version, and
// instance types.
//
// This member is required.
VcfVersions []types.VcfVersionInfo
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ListEnvironmentHostsAPIClient ¶
type ListEnvironmentHostsAPIClient interface {
ListEnvironmentHosts(context.Context, *ListEnvironmentHostsInput, ...func(*Options)) (*ListEnvironmentHostsOutput, error)
}
ListEnvironmentHostsAPIClient is a client that implements the ListEnvironmentHosts operation.
type ListEnvironmentHostsInput ¶
type ListEnvironmentHostsInput struct {
// A unique ID for the environment.
//
// This member is required.
EnvironmentId *string
// The maximum number of results to return. If you specify MaxResults in the
// request, the response includes information up to the limit specified.
MaxResults *int32
// 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.
NextToken *string
// contains filtered or unexported fields
}
type ListEnvironmentHostsOutput ¶
type ListEnvironmentHostsOutput struct {
// A list of hosts in the environment.
EnvironmentHosts []types.Host
// A unique pagination token for next page results. Make the call again using this
// token to retrieve the next page.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type ListEnvironmentHostsPaginator ¶
type ListEnvironmentHostsPaginator struct {
// contains filtered or unexported fields
}
ListEnvironmentHostsPaginator is a paginator for ListEnvironmentHosts
func NewListEnvironmentHostsPaginator ¶
func NewListEnvironmentHostsPaginator(client ListEnvironmentHostsAPIClient, params *ListEnvironmentHostsInput, optFns ...func(*ListEnvironmentHostsPaginatorOptions)) *ListEnvironmentHostsPaginator
NewListEnvironmentHostsPaginator returns a new ListEnvironmentHostsPaginator
func (*ListEnvironmentHostsPaginator) HasMorePages ¶
func (p *ListEnvironmentHostsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListEnvironmentHostsPaginator) NextPage ¶
func (p *ListEnvironmentHostsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEnvironmentHostsOutput, error)
NextPage retrieves the next ListEnvironmentHosts page.
type ListEnvironmentHostsPaginatorOptions ¶
type ListEnvironmentHostsPaginatorOptions struct {
// The maximum number of results to return. If you specify MaxResults in the
// request, the response includes information up to the limit specified.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListEnvironmentHostsPaginatorOptions is the paginator options for ListEnvironmentHosts
type ListEnvironmentVlansAPIClient ¶
type ListEnvironmentVlansAPIClient interface {
ListEnvironmentVlans(context.Context, *ListEnvironmentVlansInput, ...func(*Options)) (*ListEnvironmentVlansOutput, error)
}
ListEnvironmentVlansAPIClient is a client that implements the ListEnvironmentVlans operation.
type ListEnvironmentVlansInput ¶
type ListEnvironmentVlansInput struct {
// A unique ID for the environment.
//
// This member is required.
EnvironmentId *string
// The maximum number of results to return. If you specify MaxResults in the
// request, the response includes information up to the limit specified.
MaxResults *int32
// 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.
NextToken *string
// contains filtered or unexported fields
}
type ListEnvironmentVlansOutput ¶
type ListEnvironmentVlansOutput struct {
// A list of VLANs that are associated with the specified environment.
EnvironmentVlans []types.Vlan
// A unique pagination token for next page results. Make the call again using this
// token to retrieve the next page.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type ListEnvironmentVlansPaginator ¶
type ListEnvironmentVlansPaginator struct {
// contains filtered or unexported fields
}
ListEnvironmentVlansPaginator is a paginator for ListEnvironmentVlans
func NewListEnvironmentVlansPaginator ¶
func NewListEnvironmentVlansPaginator(client ListEnvironmentVlansAPIClient, params *ListEnvironmentVlansInput, optFns ...func(*ListEnvironmentVlansPaginatorOptions)) *ListEnvironmentVlansPaginator
NewListEnvironmentVlansPaginator returns a new ListEnvironmentVlansPaginator
func (*ListEnvironmentVlansPaginator) HasMorePages ¶
func (p *ListEnvironmentVlansPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListEnvironmentVlansPaginator) NextPage ¶
func (p *ListEnvironmentVlansPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEnvironmentVlansOutput, error)
NextPage retrieves the next ListEnvironmentVlans page.
type ListEnvironmentVlansPaginatorOptions ¶
type ListEnvironmentVlansPaginatorOptions struct {
// The maximum number of results to return. If you specify MaxResults in the
// request, the response includes information up to the limit specified.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListEnvironmentVlansPaginatorOptions is the paginator options for ListEnvironmentVlans
type ListEnvironmentsAPIClient ¶
type ListEnvironmentsAPIClient interface {
ListEnvironments(context.Context, *ListEnvironmentsInput, ...func(*Options)) (*ListEnvironmentsOutput, error)
}
ListEnvironmentsAPIClient is a client that implements the ListEnvironments operation.
type ListEnvironmentsInput ¶
type ListEnvironmentsInput struct {
// The maximum number of results to return. If you specify MaxResults in the
// request, the response includes information up to the limit specified.
MaxResults *int32
// 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.
NextToken *string
// The state of an environment. Used to filter response results to return only
// environments with the specified environmentState .
State []types.EnvironmentState
// contains filtered or unexported fields
}
type ListEnvironmentsOutput ¶
type ListEnvironmentsOutput struct {
// A list of environments with summarized environment details.
EnvironmentSummaries []types.EnvironmentSummary
// A unique pagination token for next page results. Make the call again using this
// token to retrieve the next page.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type ListEnvironmentsPaginator ¶
type ListEnvironmentsPaginator struct {
// contains filtered or unexported fields
}
ListEnvironmentsPaginator is a paginator for ListEnvironments
func NewListEnvironmentsPaginator ¶
func NewListEnvironmentsPaginator(client ListEnvironmentsAPIClient, params *ListEnvironmentsInput, optFns ...func(*ListEnvironmentsPaginatorOptions)) *ListEnvironmentsPaginator
NewListEnvironmentsPaginator returns a new ListEnvironmentsPaginator
func (*ListEnvironmentsPaginator) HasMorePages ¶
func (p *ListEnvironmentsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListEnvironmentsPaginator) NextPage ¶
func (p *ListEnvironmentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListEnvironmentsOutput, error)
NextPage retrieves the next ListEnvironments page.
type ListEnvironmentsPaginatorOptions ¶
type ListEnvironmentsPaginatorOptions struct {
// The maximum number of results to return. If you specify MaxResults in the
// request, the response includes information up to the limit specified.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListEnvironmentsPaginatorOptions is the paginator options for ListEnvironments
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct {
// The Amazon Resource Name (ARN) that identifies the resource to list tags for.
//
// This member is required.
ResourceArn *string
// contains filtered or unexported fields
}
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct {
// The tags for the resource.
Tags map[string]string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type Options ¶
type Options struct {
// Set of options to modify how an operation is invoked. These apply to all
// operations invoked for this client. Use functional options on operation call to
// modify this list for per operation behavior.
APIOptions []func(*middleware.Stack) error
// The optional application specific identifier appended to the User-Agent header.
AppID string
// This endpoint will be given as input to an EndpointResolverV2. It is used for
// providing a custom base endpoint that is subject to modifications by the
// processing EndpointResolverV2.
BaseEndpoint *string
// Configures the events that will be sent to the configured logger.
ClientLogMode aws.ClientLogMode
// The credentials object to use when signing requests.
Credentials aws.CredentialsProvider
// The configuration DefaultsMode that the SDK should use when constructing the
// clients initial default settings.
DefaultsMode aws.DefaultsMode
// The endpoint options to be used when attempting to resolve an endpoint.
EndpointOptions EndpointResolverOptions
// The service endpoint resolver.
//
// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
// value for this field will likely prevent you from using any endpoint-related
// service features released after the introduction of EndpointResolverV2 and
// BaseEndpoint.
//
// To migrate an EndpointResolver implementation that uses a custom endpoint, set
// the client option BaseEndpoint instead.
EndpointResolver EndpointResolver
// Resolves the endpoint used for a particular service operation. This should be
// used over the deprecated EndpointResolver.
EndpointResolverV2 EndpointResolverV2
// Signature Version 4 (SigV4) Signer
HTTPSignerV4 HTTPSignerV4
// Provides idempotency tokens values that will be automatically populated into
// idempotent API operations.
IdempotencyTokenProvider IdempotencyTokenProvider
// The logger writer interface to write logging messages to.
Logger logging.Logger
// The client meter provider.
MeterProvider metrics.MeterProvider
// The region to send requests to. (Required)
Region string
// RetryMaxAttempts specifies the maximum number attempts an API client will call
// an operation that fails with a retryable error. A value of 0 is ignored, and
// will not be used to configure the API client created default retryer, or modify
// per operation call's retry max attempts.
//
// If specified in an operation call's functional options with a value that is
// different than the constructed client's Options, the Client's Retryer will be
// wrapped to use the operation's specific RetryMaxAttempts value.
RetryMaxAttempts int
// RetryMode specifies the retry mode the API client will be created with, if
// Retryer option is not also specified.
//
// When creating a new API Clients this member will only be used if the Retryer
// Options member is nil. This value will be ignored if Retryer is not nil.
//
// Currently does not support per operation call overrides, may in the future.
RetryMode aws.RetryMode
// Retryer guides how HTTP requests should be retried in case of recoverable
// failures. When nil the API client will use a default retryer. The kind of
// default retry created by the API client can be changed with the RetryMode
// option.
Retryer aws.Retryer
// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
// should not populate this structure programmatically, or rely on the values here
// within your applications.
RuntimeEnvironment aws.RuntimeEnvironment
// The client tracer provider.
TracerProvider tracing.TracerProvider
// The HTTP client to invoke API calls with. Defaults to client's default HTTP
// implementation if nil.
HTTPClient HTTPClient
// Client registry of operation interceptors.
Interceptors smithyhttp.InterceptorRegistry
// The auth scheme resolver which determines how to authenticate for each
// operation.
AuthSchemeResolver AuthSchemeResolver
// The list of auth schemes supported by the client.
AuthSchemes []smithyhttp.AuthScheme
// Priority list of preferred auth scheme names (e.g. sigv4a).
AuthSchemePreference []string
// contains filtered or unexported fields
}
func (Options) GetIdentityResolver ¶
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type ResolveEndpoint ¶
type ResolveEndpoint struct {
Resolver EndpointResolver
Options EndpointResolverOptions
}
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type TagResourceInput ¶
type TagResourceInput struct {
// The Amazon Resource Name (ARN) of the resource to add tags to.
//
// This member is required.
ResourceArn *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.
//
// This member is required.
Tags map[string]string
// contains filtered or unexported fields
}
type TagResourceOutput ¶
type TagResourceOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
type UntagResourceInput ¶
type UntagResourceOutput ¶
type UntagResourceOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Source Files
¶
- api_client.go
- api_op_AssociateEipToVlan.go
- api_op_CreateEnvironment.go
- api_op_CreateEnvironmentHost.go
- api_op_DeleteEnvironment.go
- api_op_DeleteEnvironmentHost.go
- api_op_DisassociateEipFromVlan.go
- api_op_GetEnvironment.go
- api_op_GetVersions.go
- api_op_ListEnvironmentHosts.go
- api_op_ListEnvironmentVlans.go
- api_op_ListEnvironments.go
- api_op_ListTagsForResource.go
- api_op_TagResource.go
- api_op_UntagResource.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go