backupgateway

package module
v1.20.12 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 24, 2025 License: Apache-2.0 Imports: 43 Imported by: 6

Documentation

Overview

Package backupgateway provides the API client, operations, and parameter types for AWS Backup Gateway.

Backup gateway

Backup gateway connects Backup to your hypervisor, so you can create, store, and restore backups of your virtual machines (VMs) anywhere, whether on-premises or in the VMware Cloud (VMC) on Amazon Web Services.

Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.

Use Backup to assign virtual or on-premises resources to a backup plan, or run on-demand backups. Once you have backed up your resources, you can view them and restore them like any resource supported by Backup.

To download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways, then choose Create gateway.

Index

Constants

View Source 
const ServiceAPIVersion = "2021-01-01"
View Source 
const ServiceID = "Backup Gateway"

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 added in v1.10.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.13.2 

func WithSigV4SigningName(name string) func(*Options)

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 added in v1.13.2 

func WithSigV4SigningRegion(region string) func(*Options)

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 AssociateGatewayToServerInput 

type AssociateGatewayToServerInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
	// to return a list of gateways for your account and Amazon Web Services Region.
	//
	// This member is required.
	GatewayArn *string

	// The Amazon Resource Name (ARN) of the server that hosts your virtual machines.
	//
	// This member is required.
	ServerArn *string
	// contains filtered or unexported fields
}

type AssociateGatewayToServerOutput 

type AssociateGatewayToServerOutput struct {

	// The Amazon Resource Name (ARN) of a gateway.
	GatewayArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters added in v1.13.2 

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 added in v1.13.2 

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 AWS Backup Gateway.

func New 

func New(options Options, optFns ...func(*Options)) *Client

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 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateGatewayToServer 

func (c *Client) AssociateGatewayToServer(ctx context.Context, params *AssociateGatewayToServerInput, optFns ...func(*Options)) (*AssociateGatewayToServerOutput, error)

Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.

func (*Client) CreateGateway 

func (c *Client) CreateGateway(ctx context.Context, params *CreateGatewayInput, optFns ...func(*Options)) (*CreateGatewayOutput, error)

Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.

func (*Client) DeleteGateway 

func (c *Client) DeleteGateway(ctx context.Context, params *DeleteGatewayInput, optFns ...func(*Options)) (*DeleteGatewayOutput, error)

Deletes a backup gateway.

func (*Client) DeleteHypervisor 

func (c *Client) DeleteHypervisor(ctx context.Context, params *DeleteHypervisorInput, optFns ...func(*Options)) (*DeleteHypervisorOutput, error)

Deletes a hypervisor.

func (*Client) DisassociateGatewayFromServer 

func (c *Client) DisassociateGatewayFromServer(ctx context.Context, params *DisassociateGatewayFromServerInput, optFns ...func(*Options)) (*DisassociateGatewayFromServerOutput, error)

Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.

func (*Client) GetBandwidthRateLimitSchedule added in v1.8.0 

func (c *Client) GetBandwidthRateLimitSchedule(ctx context.Context, params *GetBandwidthRateLimitScheduleInput, optFns ...func(*Options)) (*GetBandwidthRateLimitScheduleOutput, error)

Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule.

func (*Client) GetGateway added in v1.6.0 

func (c *Client) GetGateway(ctx context.Context, params *GetGatewayInput, optFns ...func(*Options)) (*GetGatewayOutput, error)

By providing the ARN (Amazon Resource Name), this API returns the gateway.

func (*Client) GetHypervisor added in v1.8.0 

func (c *Client) GetHypervisor(ctx context.Context, params *GetHypervisorInput, optFns ...func(*Options)) (*GetHypervisorOutput, error)

This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

func (*Client) GetHypervisorPropertyMappings added in v1.8.0 

func (c *Client) GetHypervisorPropertyMappings(ctx context.Context, params *GetHypervisorPropertyMappingsInput, optFns ...func(*Options)) (*GetHypervisorPropertyMappingsOutput, error)

This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.

func (*Client) GetVirtualMachine added in v1.7.0 

func (c *Client) GetVirtualMachine(ctx context.Context, params *GetVirtualMachineInput, optFns ...func(*Options)) (*GetVirtualMachineOutput, error)

By providing the ARN (Amazon Resource Name), this API returns the virtual machine.

func (*Client) ImportHypervisorConfiguration 

func (c *Client) ImportHypervisorConfiguration(ctx context.Context, params *ImportHypervisorConfigurationInput, optFns ...func(*Options)) (*ImportHypervisorConfigurationOutput, error)

Connect to a hypervisor by importing its configuration.

func (*Client) ListGateways 

func (c *Client) ListGateways(ctx context.Context, params *ListGatewaysInput, optFns ...func(*Options)) (*ListGatewaysOutput, error)

Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).

func (*Client) ListHypervisors 

func (c *Client) ListHypervisors(ctx context.Context, params *ListHypervisorsInput, optFns ...func(*Options)) (*ListHypervisorsOutput, error)

Lists your hypervisors.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).

func (*Client) ListVirtualMachines 

func (c *Client) ListVirtualMachines(ctx context.Context, params *ListVirtualMachinesInput, optFns ...func(*Options)) (*ListVirtualMachinesOutput, error)

Lists your virtual machines.

func (*Client) Options added in v1.14.0 

func (c *Client) Options() 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) PutBandwidthRateLimitSchedule added in v1.8.0 

func (c *Client) PutBandwidthRateLimitSchedule(ctx context.Context, params *PutBandwidthRateLimitScheduleInput, optFns ...func(*Options)) (*PutBandwidthRateLimitScheduleOutput, error)

This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule.

func (*Client) PutHypervisorPropertyMappings added in v1.8.0 

func (c *Client) PutHypervisorPropertyMappings(ctx context.Context, params *PutHypervisorPropertyMappingsInput, optFns ...func(*Options)) (*PutHypervisorPropertyMappingsOutput, error)

This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the on-premises hypervisor to the properties available in Amazon Web Services.

func (*Client) PutMaintenanceStartTime 

func (c *Client) PutMaintenanceStartTime(ctx context.Context, params *PutMaintenanceStartTimeInput, optFns ...func(*Options)) (*PutMaintenanceStartTimeOutput, error)

Set the maintenance start time for a gateway.

func (*Client) StartVirtualMachinesMetadataSync added in v1.8.0 

func (c *Client) StartVirtualMachinesMetadataSync(ctx context.Context, params *StartVirtualMachinesMetadataSyncInput, optFns ...func(*Options)) (*StartVirtualMachinesMetadataSyncOutput, error)

This action sends a request to sync metadata across the specified virtual machines.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Tag the resource.

func (*Client) TestHypervisorConfiguration 

func (c *Client) TestHypervisorConfiguration(ctx context.Context, params *TestHypervisorConfigurationInput, optFns ...func(*Options)) (*TestHypervisorConfigurationOutput, error)

Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Removes tags from the resource.

func (*Client) UpdateGatewayInformation 

func (c *Client) UpdateGatewayInformation(ctx context.Context, params *UpdateGatewayInformationInput, optFns ...func(*Options)) (*UpdateGatewayInformationOutput, error)

Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.

func (*Client) UpdateGatewaySoftwareNow added in v1.6.0 

func (c *Client) UpdateGatewaySoftwareNow(ctx context.Context, params *UpdateGatewaySoftwareNowInput, optFns ...func(*Options)) (*UpdateGatewaySoftwareNowOutput, error)

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete.

func (*Client) UpdateHypervisor 

func (c *Client) UpdateHypervisor(ctx context.Context, params *UpdateHypervisorInput, optFns ...func(*Options)) (*UpdateHypervisorOutput, error)

Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request.

type CreateGatewayInput 

type CreateGatewayInput struct {

	// The activation key of the created gateway.
	//
	// This member is required.
	ActivationKey *string

	// The display name of the created gateway.
	//
	// This member is required.
	GatewayDisplayName *string

	// The type of created gateway.
	//
	// This member is required.
	GatewayType types.GatewayType

	// A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type CreateGatewayOutput 

type CreateGatewayOutput struct {

	// The Amazon Resource Name (ARN) of the gateway you create.
	GatewayArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteGatewayInput 

type DeleteGatewayInput struct {

	// The Amazon Resource Name (ARN) of the gateway to delete.
	//
	// This member is required.
	GatewayArn *string
	// contains filtered or unexported fields
}

type DeleteGatewayOutput 

type DeleteGatewayOutput struct {

	// The Amazon Resource Name (ARN) of the gateway you deleted.
	GatewayArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteHypervisorInput 

type DeleteHypervisorInput struct {

	// The Amazon Resource Name (ARN) of the hypervisor to delete.
	//
	// This member is required.
	HypervisorArn *string
	// contains filtered or unexported fields
}

type DeleteHypervisorOutput 

type DeleteHypervisorOutput struct {

	// The Amazon Resource Name (ARN) of the hypervisor you deleted.
	HypervisorArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateGatewayFromServerInput 

type DisassociateGatewayFromServerInput struct {

	// The Amazon Resource Name (ARN) of the gateway to disassociate.
	//
	// This member is required.
	GatewayArn *string
	// contains filtered or unexported fields
}

type DisassociateGatewayFromServerOutput 

type DisassociateGatewayFromServerOutput struct {

	// The Amazon Resource Name (ARN) of the gateway you disassociated.
	GatewayArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.10.0 

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 added in v1.10.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.10.0 

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 added in v1.10.0 

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 added in v1.10.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetBandwidthRateLimitScheduleInput added in v1.8.0 

type GetBandwidthRateLimitScheduleInput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways]ListGateways operation
	// to return a list of gateways for your account and Amazon Web Services Region.
	//
	// [ListGateways]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html
	//
	// This member is required.
	GatewayArn *string
	// contains filtered or unexported fields
}

type GetBandwidthRateLimitScheduleOutput added in v1.8.0 

type GetBandwidthRateLimitScheduleOutput struct {

	// An array containing bandwidth rate limit schedule intervals for a gateway. When
	// no bandwidth rate limit intervals have been scheduled, the array is empty.
	BandwidthRateLimitIntervals []types.BandwidthRateLimitInterval

	// The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways]ListGateways operation
	// to return a list of gateways for your account and Amazon Web Services Region.
	//
	// [ListGateways]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html
	GatewayArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetGatewayInput added in v1.6.0 

type GetGatewayInput struct {

	// The Amazon Resource Name (ARN) of the gateway.
	//
	// This member is required.
	GatewayArn *string
	// contains filtered or unexported fields
}

type GetGatewayOutput added in v1.6.0 

type GetGatewayOutput struct {

	// By providing the ARN (Amazon Resource Name), this API returns the gateway.
	Gateway *types.GatewayDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetHypervisorInput added in v1.8.0 

type GetHypervisorInput struct {

	// The Amazon Resource Name (ARN) of the hypervisor.
	//
	// This member is required.
	HypervisorArn *string
	// contains filtered or unexported fields
}

type GetHypervisorOutput added in v1.8.0 

type GetHypervisorOutput struct {

	// Details about the requested hypervisor.
	Hypervisor *types.HypervisorDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetHypervisorPropertyMappingsInput added in v1.8.0 

type GetHypervisorPropertyMappingsInput struct {

	// The Amazon Resource Name (ARN) of the hypervisor.
	//
	// This member is required.
	HypervisorArn *string
	// contains filtered or unexported fields
}

type GetHypervisorPropertyMappingsOutput added in v1.8.0 

type GetHypervisorPropertyMappingsOutput struct {

	// The Amazon Resource Name (ARN) of the hypervisor.
	HypervisorArn *string

	// The Amazon Resource Name (ARN) of the IAM role.
	IamRoleArn *string

	// This is a display of the mappings of on-premises VMware tags to the Amazon Web
	// Services tags.
	VmwareToAwsTagMappings []types.VmwareToAwsTagMapping

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetVirtualMachineInput added in v1.7.0 

type GetVirtualMachineInput struct {

	// The Amazon Resource Name (ARN) of the virtual machine.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type GetVirtualMachineOutput added in v1.7.0 

type GetVirtualMachineOutput struct {

	// This object contains the basic attributes of VirtualMachine contained by the
	// output of GetVirtualMachine
	VirtualMachine *types.VirtualMachineDetails

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ImportHypervisorConfigurationInput 

type ImportHypervisorConfigurationInput struct {

	// The server host of the hypervisor. This can be either an IP address or a
	// fully-qualified domain name (FQDN).
	//
	// This member is required.
	Host *string

	// The name of the hypervisor.
	//
	// This member is required.
	Name *string

	// The Key Management Service for the hypervisor.
	KmsKeyArn *string

	// The password for the hypervisor.
	Password *string

	// The tags of the hypervisor configuration to import.
	Tags []types.Tag

	// The username for the hypervisor.
	Username *string
	// contains filtered or unexported fields
}

type ImportHypervisorConfigurationOutput 

type ImportHypervisorConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the hypervisor you disassociated.
	HypervisorArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListGatewaysAPIClient 

type ListGatewaysAPIClient interface {
	ListGateways(context.Context, *ListGatewaysInput, ...func(*Options)) (*ListGatewaysOutput, error)
}

ListGatewaysAPIClient is a client that implements the ListGateways operation.

type ListGatewaysInput 

type ListGatewaysInput struct {

	// The maximum number of gateways to list.
	MaxResults *int32

	// The next item following a partial list of returned resources. For example, if a
	// request is made to return MaxResults number of resources, NextToken allows you
	// to return more items in your list starting at the location pointed to by the
	// next token.
	NextToken *string
	// contains filtered or unexported fields
}

type ListGatewaysOutput 

type ListGatewaysOutput struct {

	// A list of your gateways.
	Gateways []types.Gateway

	// The next item following a partial list of returned resources. For example, if a
	// request is made to return maxResults number of resources, NextToken allows you
	// to return more items in your list starting at the location pointed to by the
	// next token.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListGatewaysPaginator 

type ListGatewaysPaginator struct {
	// contains filtered or unexported fields
}

ListGatewaysPaginator is a paginator for ListGateways

func NewListGatewaysPaginator 

func NewListGatewaysPaginator(client ListGatewaysAPIClient, params *ListGatewaysInput, optFns ...func(*ListGatewaysPaginatorOptions)) *ListGatewaysPaginator

NewListGatewaysPaginator returns a new ListGatewaysPaginator

func (*ListGatewaysPaginator) HasMorePages 

func (p *ListGatewaysPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListGatewaysPaginator) NextPage 

func (p *ListGatewaysPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGatewaysOutput, error)

NextPage retrieves the next ListGateways page.

type ListGatewaysPaginatorOptions 

type ListGatewaysPaginatorOptions struct {
	// The maximum number of gateways to list.
	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
}

ListGatewaysPaginatorOptions is the paginator options for ListGateways

type ListHypervisorsAPIClient 

type ListHypervisorsAPIClient interface {
	ListHypervisors(context.Context, *ListHypervisorsInput, ...func(*Options)) (*ListHypervisorsOutput, error)
}

ListHypervisorsAPIClient is a client that implements the ListHypervisors operation.

type ListHypervisorsInput 

type ListHypervisorsInput struct {

	// The maximum number of hypervisors to list.
	MaxResults *int32

	// The next item following a partial list of returned resources. For example, if a
	// request is made to return maxResults number of resources, NextToken allows you
	// to return more items in your list starting at the location pointed to by the
	// next token.
	NextToken *string
	// contains filtered or unexported fields
}

type ListHypervisorsOutput 

type ListHypervisorsOutput struct {

	// A list of your Hypervisor objects, ordered by their Amazon Resource Names
	// (ARNs).
	Hypervisors []types.Hypervisor

	// The next item following a partial list of returned resources. For example, if a
	// request is made to return maxResults number of resources, NextToken allows you
	// to return more items in your list starting at the location pointed to by the
	// next token.
	NextToken *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListHypervisorsPaginator 

type ListHypervisorsPaginator struct {
	// contains filtered or unexported fields
}

ListHypervisorsPaginator is a paginator for ListHypervisors

func NewListHypervisorsPaginator 

func NewListHypervisorsPaginator(client ListHypervisorsAPIClient, params *ListHypervisorsInput, optFns ...func(*ListHypervisorsPaginatorOptions)) *ListHypervisorsPaginator

NewListHypervisorsPaginator returns a new ListHypervisorsPaginator

func (*ListHypervisorsPaginator) HasMorePages 

func (p *ListHypervisorsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListHypervisorsPaginator) NextPage 

func (p *ListHypervisorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListHypervisorsOutput, error)

NextPage retrieves the next ListHypervisors page.

type ListHypervisorsPaginatorOptions 

type ListHypervisorsPaginatorOptions struct {
	// The maximum number of hypervisors to list.
	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
}

ListHypervisorsPaginatorOptions is the paginator options for ListHypervisors

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource's tags to list.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The Amazon Resource Name (ARN) of the resource's tags that you listed.
	ResourceArn *string

	// A list of the resource's tags.
	Tags []types.Tag

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListVirtualMachinesAPIClient 

type ListVirtualMachinesAPIClient interface {
	ListVirtualMachines(context.Context, *ListVirtualMachinesInput, ...func(*Options)) (*ListVirtualMachinesOutput, error)
}

ListVirtualMachinesAPIClient is a client that implements the ListVirtualMachines operation.

type ListVirtualMachinesInput 

type ListVirtualMachinesInput struct {

	// The Amazon Resource Name (ARN) of the hypervisor connected to your virtual
	// machine.
	HypervisorArn *string

	// The maximum number of virtual machines to list.
	MaxResults *int32

	// The next item following a partial list of returned resources. For example, if a
	// request is made to return maxResults number of resources, NextToken allows you
	// to return more items in your list starting at the location pointed to by the
	// next token.
	NextToken *string
	// contains filtered or unexported fields
}

type ListVirtualMachinesOutput 

type ListVirtualMachinesOutput struct {

	// The next item following a partial list of returned resources. For example, if a
	// request is made to return maxResults number of resources, NextToken allows you
	// to return more items in your list starting at the location pointed to by the
	// next token.
	NextToken *string

	// A list of your VirtualMachine objects, ordered by their Amazon Resource Names
	// (ARNs).
	VirtualMachines []types.VirtualMachine

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListVirtualMachinesPaginator 

type ListVirtualMachinesPaginator struct {
	// contains filtered or unexported fields
}

ListVirtualMachinesPaginator is a paginator for ListVirtualMachines

func NewListVirtualMachinesPaginator 

func NewListVirtualMachinesPaginator(client ListVirtualMachinesAPIClient, params *ListVirtualMachinesInput, optFns ...func(*ListVirtualMachinesPaginatorOptions)) *ListVirtualMachinesPaginator

NewListVirtualMachinesPaginator returns a new ListVirtualMachinesPaginator

func (*ListVirtualMachinesPaginator) HasMorePages 

func (p *ListVirtualMachinesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListVirtualMachinesPaginator) NextPage 

func (p *ListVirtualMachinesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVirtualMachinesOutput, error)

NextPage retrieves the next ListVirtualMachines page.

type ListVirtualMachinesPaginatorOptions 

type ListVirtualMachinesPaginatorOptions struct {
	// The maximum number of virtual machines to list.
	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
}

ListVirtualMachinesPaginatorOptions is the paginator options for ListVirtualMachines

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

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

	// 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
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.13.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type PutBandwidthRateLimitScheduleInput added in v1.8.0 

type PutBandwidthRateLimitScheduleInput struct {

	// An array containing bandwidth rate limit schedule intervals for a gateway. When
	// no bandwidth rate limit intervals have been scheduled, the array is empty.
	//
	// This member is required.
	BandwidthRateLimitIntervals []types.BandwidthRateLimitInterval

	// The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways]ListGateways operation
	// to return a list of gateways for your account and Amazon Web Services Region.
	//
	// [ListGateways]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html
	//
	// This member is required.
	GatewayArn *string
	// contains filtered or unexported fields
}

type PutBandwidthRateLimitScheduleOutput added in v1.8.0 

type PutBandwidthRateLimitScheduleOutput struct {

	// The Amazon Resource Name (ARN) of the gateway. Use the [ListGateways]ListGateways operation
	// to return a list of gateways for your account and Amazon Web Services Region.
	//
	// [ListGateways]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html
	GatewayArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutHypervisorPropertyMappingsInput added in v1.8.0 

type PutHypervisorPropertyMappingsInput struct {

	// The Amazon Resource Name (ARN) of the hypervisor.
	//
	// This member is required.
	HypervisorArn *string

	// The Amazon Resource Name (ARN) of the IAM role.
	//
	// This member is required.
	IamRoleArn *string

	// This action requests the mappings of on-premises VMware tags to the Amazon Web
	// Services tags.
	//
	// This member is required.
	VmwareToAwsTagMappings []types.VmwareToAwsTagMapping
	// contains filtered or unexported fields
}

type PutHypervisorPropertyMappingsOutput added in v1.8.0 

type PutHypervisorPropertyMappingsOutput struct {

	// The Amazon Resource Name (ARN) of the hypervisor.
	HypervisorArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type PutMaintenanceStartTimeInput 

type PutMaintenanceStartTimeInput struct {

	// The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance
	// start time.
	//
	// This member is required.
	GatewayArn *string

	// The hour of the day to start maintenance on a gateway.
	//
	// This member is required.
	HourOfDay *int32

	// The minute of the hour to start maintenance on a gateway.
	//
	// This member is required.
	MinuteOfHour *int32

	// The day of the month start maintenance on a gateway.
	//
	// Valid values range from Sunday to Saturday .
	DayOfMonth *int32

	// The day of the week to start maintenance on a gateway.
	DayOfWeek *int32
	// contains filtered or unexported fields
}

type PutMaintenanceStartTimeOutput 

type PutMaintenanceStartTimeOutput struct {

	// The Amazon Resource Name (ARN) of a gateway for which you set the maintenance
	// start time.
	GatewayArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 StartVirtualMachinesMetadataSyncInput added in v1.8.0 

type StartVirtualMachinesMetadataSyncInput struct {

	// The Amazon Resource Name (ARN) of the hypervisor.
	//
	// This member is required.
	HypervisorArn *string
	// contains filtered or unexported fields
}

type StartVirtualMachinesMetadataSyncOutput added in v1.8.0 

type StartVirtualMachinesMetadataSyncOutput struct {

	// The Amazon Resource Name (ARN) of the hypervisor.
	HypervisorArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to tag.
	//
	// This member is required.
	ResourceARN *string

	// A list of tags to assign to the resource.
	//
	// This member is required.
	Tags []types.Tag
	// contains filtered or unexported fields
}

type TagResourceOutput 

type TagResourceOutput struct {

	// The Amazon Resource Name (ARN) of the resource you tagged.
	ResourceARN *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TestHypervisorConfigurationInput 

type TestHypervisorConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.
	//
	// This member is required.
	GatewayArn *string

	// The server host of the hypervisor. This can be either an IP address or a
	// fully-qualified domain name (FQDN).
	//
	// This member is required.
	Host *string

	// The password for the hypervisor.
	Password *string

	// The username for the hypervisor.
	Username *string
	// contains filtered or unexported fields
}

type TestHypervisorConfigurationOutput 

type TestHypervisorConfigurationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput 

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource from which to remove tags.
	//
	// This member is required.
	ResourceARN *string

	// The list of tag keys specifying which tags to remove.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

type UntagResourceOutput struct {

	// The Amazon Resource Name (ARN) of the resource from which you removed tags.
	ResourceARN *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateGatewayInformationInput 

type UpdateGatewayInformationInput struct {

	// The Amazon Resource Name (ARN) of the gateway to update.
	//
	// This member is required.
	GatewayArn *string

	// The updated display name of the gateway.
	GatewayDisplayName *string
	// contains filtered or unexported fields
}

type UpdateGatewayInformationOutput 

type UpdateGatewayInformationOutput struct {

	// The Amazon Resource Name (ARN) of the gateway you updated.
	GatewayArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateGatewaySoftwareNowInput added in v1.6.0 

type UpdateGatewaySoftwareNowInput struct {

	// The Amazon Resource Name (ARN) of the gateway to be updated.
	//
	// This member is required.
	GatewayArn *string
	// contains filtered or unexported fields
}

type UpdateGatewaySoftwareNowOutput added in v1.6.0 

type UpdateGatewaySoftwareNowOutput struct {

	// The Amazon Resource Name (ARN) of the gateway you updated.
	GatewayArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateHypervisorInput 

type UpdateHypervisorInput struct {

	// The Amazon Resource Name (ARN) of the hypervisor to update.
	//
	// This member is required.
	HypervisorArn *string

	// The updated host of the hypervisor. This can be either an IP address or a
	// fully-qualified domain name (FQDN).
	Host *string

	// The Amazon Resource Name (ARN) of the group of gateways within the requested
	// log.
	LogGroupArn *string

	// The updated name for the hypervisor
	Name *string

	// The updated password for the hypervisor.
	Password *string

	// The updated username for the hypervisor.
	Username *string
	// contains filtered or unexported fields
}

type UpdateHypervisorOutput 

type UpdateHypervisorOutput struct {

	// The Amazon Resource Name (ARN) of the hypervisor you updated.
	HypervisorArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.