dsql

package module
v1.3.0 Latest Latest
Warning

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

 Go to latest Published: May 13, 2025 License: Apache-2.0 Imports: 47 Imported by: 3

Documentation

Overview

Package dsql provides the API client, operations, and parameter types for Amazon Aurora DSQL.

This is an interface reference for Amazon Aurora DSQL. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Aurora DSQL.

Amazon Aurora DSQL is a serverless, distributed SQL database suitable for workloads of any size. is available in both single-Region and multi-Region configurations, so your clusters and databases are always available even if an Availability Zone or an Amazon Web Services Region are unavailable. lets you focus on using your data to acquire new insights for your business and customers.

Index

Constants

View Source 
const ServiceAPIVersion = "2018-05-10"
View Source 
const ServiceID = "DSQL"

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 

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 

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

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) CreateCluster 

func (c *Client) CreateCluster(ctx context.Context, params *CreateClusterInput, optFns ...func(*Options)) (*CreateClusterOutput, error)

This operation creates a cluster in Amazon Aurora DSQL. You need the following permissions to use this operation.

Permission to create a cluster.

dsql:CreateCluster Resources: arn:aws:dsql:region:account-id:cluster/*

Permission to add tags to a resource.

dsql:TagResource Resources: arn:aws:dsql:region:account-id:cluster/*

Permission to configure multi-region properties for a cluster.

dsql:PutMultiRegionProperties Resources: arn:aws:dsql:region:account-id:cluster/*

When specifying multiRegionProperties.clusters.

dsql:AddPeerCluster Permission to add peer clusters.

Resources:

  • Local cluster: arn:aws:dsql:region:account-id:cluster/*

  • Each peer cluster: exact ARN of each specified peer cluster

When specifying multiRegionProperties.witnessRegion.

dsql:PutWitnessRegion Permission to set a witness region.

Resources: arn:aws:dsql:region:account-id:cluster/*

Condition Keys: dsql:WitnessRegion (matching the specified witness region)

This permission is checked both in the cluster Region and in the witness Region.

Important Notes for Multi-Region Operations

  • The witness region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region.

  • When updating clusters with peer relationships, permissions are checked for both adding and removing peers.

func (*Client) CreateMultiRegionClusters deprecated 

func (c *Client) CreateMultiRegionClusters(ctx context.Context, params *CreateMultiRegionClustersInput, optFns ...func(*Options)) (*CreateMultiRegionClustersOutput, error)

Creates multi-Region clusters in Amazon Aurora DSQL. Multi-Region clusters require a linked Region list, which is an array of the Regions in which you want to create linked clusters. Multi-Region clusters require a witness Region, which participates in quorum in failure scenarios.

Deprecated: The CreateMultiRegionClusters API is deprecated. Use the CreateCluster API with multi-Region properties to create a multi-Region cluster.

func (*Client) DeleteCluster 

func (c *Client) DeleteCluster(ctx context.Context, params *DeleteClusterInput, optFns ...func(*Options)) (*DeleteClusterOutput, error)

Deletes a cluster in Amazon Aurora DSQL.

func (*Client) DeleteMultiRegionClusters deprecated 

func (c *Client) DeleteMultiRegionClusters(ctx context.Context, params *DeleteMultiRegionClustersInput, optFns ...func(*Options)) (*DeleteMultiRegionClustersOutput, error)

Deletes a multi-Region cluster in Amazon Aurora DSQL.

Deprecated: The DeleteMultiRegionClusters API is deprecated. To delete a multi-Region cluster, use the DeleteCluster API instead.

func (*Client) GetCluster 

func (c *Client) GetCluster(ctx context.Context, params *GetClusterInput, optFns ...func(*Options)) (*GetClusterOutput, error)

Retrieves information about a cluster.

func (*Client) GetVpcEndpointServiceName added in v1.2.0 

func (c *Client) GetVpcEndpointServiceName(ctx context.Context, params *GetVpcEndpointServiceNameInput, optFns ...func(*Options)) (*GetVpcEndpointServiceNameOutput, error)

Retrieves the VPC endpoint service name.

func (*Client) ListClusters 

func (c *Client) ListClusters(ctx context.Context, params *ListClustersInput, optFns ...func(*Options)) (*ListClustersOutput, error)

Retrieves information about a list of clusters.

func (*Client) ListTagsForResource 

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

Lists all of the tags for a resource.

func (*Client) Options 

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) TagResource 

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

Tags a resource with a map of key and value pairs.

func (*Client) UntagResource 

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

Removes a tag from a resource.

func (*Client) UpdateCluster 

func (c *Client) UpdateCluster(ctx context.Context, params *UpdateClusterInput, optFns ...func(*Options)) (*UpdateClusterOutput, error)

Updates a cluster.

Example IAM Policy for Multi-Region Operations

The following IAM policy grants permissions for multi-Region operations.

The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.

Important Notes for Multi-Region Operations

  • The witness region specified in multiRegionProperties.witnessRegion cannot be the same as the cluster's Region.

  • When updating clusters with peer relationships, permissions are checked for both adding and removing peers.

  • The dsql:RemovePeerCluster permission uses a wildcard ARN pattern to simplify permission management during updates.

type ClusterActiveWaiter 

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

ClusterActiveWaiter defines the waiters for ClusterActive

func NewClusterActiveWaiter 

func NewClusterActiveWaiter(client GetClusterAPIClient, optFns ...func(*ClusterActiveWaiterOptions)) *ClusterActiveWaiter

NewClusterActiveWaiter constructs a ClusterActiveWaiter.

func (*ClusterActiveWaiter) Wait 

func (w *ClusterActiveWaiter) Wait(ctx context.Context, params *GetClusterInput, maxWaitDur time.Duration, optFns ...func(*ClusterActiveWaiterOptions)) error

Wait calls the waiter function for ClusterActive waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ClusterActiveWaiter) WaitForOutput 

func (w *ClusterActiveWaiter) WaitForOutput(ctx context.Context, params *GetClusterInput, maxWaitDur time.Duration, optFns ...func(*ClusterActiveWaiterOptions)) (*GetClusterOutput, error)

WaitForOutput calls the waiter function for ClusterActive waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ClusterActiveWaiterOptions 

type ClusterActiveWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ClusterActiveWaiter will use default minimum delay of 2 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ClusterActiveWaiter will use default max delay of 120 seconds. Note
	// that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetClusterInput, *GetClusterOutput, error) (bool, error)
}

ClusterActiveWaiterOptions are waiter options for ClusterActiveWaiter

type ClusterNotExistsWaiter 

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

ClusterNotExistsWaiter defines the waiters for ClusterNotExists

func NewClusterNotExistsWaiter 

func NewClusterNotExistsWaiter(client GetClusterAPIClient, optFns ...func(*ClusterNotExistsWaiterOptions)) *ClusterNotExistsWaiter

NewClusterNotExistsWaiter constructs a ClusterNotExistsWaiter.

func (*ClusterNotExistsWaiter) Wait 

func (w *ClusterNotExistsWaiter) Wait(ctx context.Context, params *GetClusterInput, maxWaitDur time.Duration, optFns ...func(*ClusterNotExistsWaiterOptions)) error

Wait calls the waiter function for ClusterNotExists waiter. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

func (*ClusterNotExistsWaiter) WaitForOutput 

func (w *ClusterNotExistsWaiter) WaitForOutput(ctx context.Context, params *GetClusterInput, maxWaitDur time.Duration, optFns ...func(*ClusterNotExistsWaiterOptions)) (*GetClusterOutput, error)

WaitForOutput calls the waiter function for ClusterNotExists waiter and returns the output of the successful operation. The maxWaitDur is the maximum wait duration the waiter will wait. The maxWaitDur is required and must be greater than zero.

type ClusterNotExistsWaiterOptions 

type ClusterNotExistsWaiterOptions 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.
	//
	// Passing options here is functionally equivalent to passing values to this
	// config's ClientOptions field that extend the inner client's APIOptions directly.
	APIOptions []func(*middleware.Stack) error

	// Functional options to be passed to all operations invoked by this client.
	//
	// Function values that modify the inner APIOptions are applied after the waiter
	// config's own APIOptions modifiers.
	ClientOptions []func(*Options)

	// MinDelay is the minimum amount of time to delay between retries. If unset,
	// ClusterNotExistsWaiter will use default minimum delay of 2 seconds. Note that
	// MinDelay must resolve to a value lesser than or equal to the MaxDelay.
	MinDelay time.Duration

	// MaxDelay is the maximum amount of time to delay between retries. If unset or
	// set to zero, ClusterNotExistsWaiter will use default max delay of 120 seconds.
	// Note that MaxDelay must resolve to value greater than or equal to the MinDelay.
	MaxDelay time.Duration

	// LogWaitAttempts is used to enable logging for waiter retry attempts
	LogWaitAttempts bool

	// Retryable is function that can be used to override the service defined
	// waiter-behavior based on operation output, or returned error. This function is
	// used by the waiter to decide if a state is retryable or a terminal state.
	//
	// By default service-modeled logic will populate this option. This option can
	// thus be used to define a custom waiter state with fall-back to service-modeled
	// waiter state mutators.The function returns an error in case of a failure state.
	// In case of retry state, this function returns a bool value of true and nil
	// error, while in case of success it returns a bool value of false and nil error.
	Retryable func(context.Context, *GetClusterInput, *GetClusterOutput, error) (bool, error)
}

ClusterNotExistsWaiterOptions are waiter options for ClusterNotExistsWaiter

type CreateClusterInput 

type CreateClusterInput struct {

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. Idempotency ensures that an API request completes only once.
	// With an idempotent request, if the original request completes successfully, the
	// subsequent retries with the same client token return the result from the
	// original successful request and they have no additional effect.
	//
	// If you don't specify a client token, the Amazon Web Services SDK automatically
	// generates one.
	ClientToken *string

	// If enabled, you can't delete your cluster. You must first disable this property
	// before you can delete your cluster.
	DeletionProtectionEnabled *bool

	// The configuration settings when creating a multi-Region cluster, including the
	// witness region and linked cluster properties.
	MultiRegionProperties *types.MultiRegionProperties

	// A map of key and value pairs to use to tag your cluster.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateClusterOutput 

type CreateClusterOutput struct {

	// The ARN of the created cluster.
	//
	// This member is required.
	Arn *string

	// The time of when created the cluster.
	//
	// This member is required.
	CreationTime *time.Time

	// Whether deletion protection is enabled on this cluster.
	//
	// This member is required.
	DeletionProtectionEnabled *bool

	// The ID of the created cluster.
	//
	// This member is required.
	Identifier *string

	// The status of the created cluster.
	//
	// This member is required.
	Status types.ClusterStatus

	// The multi-Region cluster configuration details that were set during cluster
	// creation
	MultiRegionProperties *types.MultiRegionProperties

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

The output of a created cluster.

type CreateMultiRegionClustersInput 

type CreateMultiRegionClustersInput struct {

	// An array of the Regions in which you want to create additional clusters.
	//
	// This member is required.
	//
	// Deprecated: The CreateMultiRegionClusters API is deprecated. Use the
	// CreateCluster API with multi-Region properties to create a multi-Region cluster.
	LinkedRegionList []string

	// The witness Region of multi-Region clusters.
	//
	// This member is required.
	WitnessRegion *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. Idempotency ensures that an API request completes only once.
	// With an idempotent request, if the original request completes successfully. The
	// subsequent retries with the same client token return the result from the
	// original successful request and they have no additional effect.
	//
	// If you don't specify a client token, the Amazon Web Services SDK automatically
	// generates one.
	ClientToken *string

	// A mapping of properties to use when creating linked clusters.
	//
	// Deprecated: The CreateMultiRegionClusters API is deprecated. To create a
	// multi-Region cluster, use the CreateCluster API with multi-Region properties
	// instead.
	ClusterProperties map[string]types.LinkedClusterProperties
	// contains filtered or unexported fields
}

type CreateMultiRegionClustersOutput 

type CreateMultiRegionClustersOutput struct {

	// An array that contains the ARNs of all linked clusters.
	//
	// This member is required.
	LinkedClusterArns []string

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

type DeleteClusterInput 

type DeleteClusterInput struct {

	// The ID of the cluster to delete.
	//
	// This member is required.
	Identifier *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. Idempotency ensures that an API request completes only once.
	// With an idempotent request, if the original request completes successfully. The
	// subsequent retries with the same client token return the result from the
	// original successful request and they have no additional effect.
	//
	// If you don't specify a client token, the Amazon Web Services SDK automatically
	// generates one.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteClusterOutput 

type DeleteClusterOutput struct {

	// The ARN of the deleted cluster.
	//
	// This member is required.
	Arn *string

	// The time of when the cluster was created.
	//
	// This member is required.
	CreationTime *time.Time

	// Specifies whether deletion protection was enabled on the cluster.
	//
	// This member is required.
	//
	// Deprecated: The deletionProtectionEnabled field is deprecated in the
	// DeleteCluster API. To check deletion protection status, use the GetCluster API
	// instead.
	DeletionProtectionEnabled *bool

	// The ID of the deleted cluster.
	//
	// This member is required.
	Identifier *string

	// The status of the cluster.
	//
	// This member is required.
	Status types.ClusterStatus

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

The output from a deleted cluster.

type DeleteMultiRegionClustersInput 

type DeleteMultiRegionClustersInput struct {

	// The ARNs of the clusters linked to the cluster you want to delete. also deletes
	// these clusters as part of the operation.
	//
	// This member is required.
	LinkedClusterArns []string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. Idempotency ensures that an API request completes only once.
	// With an idempotent request, if the original request completes successfully. The
	// subsequent retries with the same client token return the result from the
	// original successful request and they have no additional effect.
	//
	// If you don't specify a client token, the Amazon Web Services SDK automatically
	// generates one.
	ClientToken *string
	// contains filtered or unexported fields
}

type DeleteMultiRegionClustersOutput 

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

type EndpointParameters 

type EndpointParameters struct {
	// 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

	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *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 GetClusterAPIClient 

type GetClusterAPIClient interface {
	GetCluster(context.Context, *GetClusterInput, ...func(*Options)) (*GetClusterOutput, error)
}

GetClusterAPIClient is a client that implements the GetCluster operation.

type GetClusterInput 

type GetClusterInput struct {

	// The ID of the cluster to retrieve.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetClusterOutput 

type GetClusterOutput struct {

	// The ARN of the retrieved cluster.
	//
	// This member is required.
	Arn *string

	// The time of when the cluster was created.
	//
	// This member is required.
	CreationTime *time.Time

	// Whether deletion protection is enabled in this cluster.
	//
	// This member is required.
	DeletionProtectionEnabled *bool

	// The ID of the retrieved cluster.
	//
	// This member is required.
	Identifier *string

	// The status of the retrieved cluster.
	//
	// This member is required.
	Status types.ClusterStatus

	// The ARNs of the clusters linked to the retrieved cluster.
	//
	// Deprecated: The linkedClusterArns field is deprecated. To see the peered
	// cluster Arns, use multiRegionProperties.cluster instead.
	LinkedClusterArns []string

	// Returns the current multi-Region cluster configuration, including witness
	// region and linked cluster information.
	MultiRegionProperties *types.MultiRegionProperties

	// Map of tags.
	Tags map[string]string

	// The witness Region of the cluster. Applicable only for multi-Region clusters.
	//
	// Deprecated: The witnessRegion field is deprecated. To see the witnessRegion,
	// use multiRegionProperties.witnessRegion instead.
	WitnessRegion *string

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

The output of a cluster.

type GetVpcEndpointServiceNameInput added in v1.2.0 

type GetVpcEndpointServiceNameInput struct {

	// The ID of the cluster to retrieve.
	//
	// This member is required.
	Identifier *string
	// contains filtered or unexported fields
}

type GetVpcEndpointServiceNameOutput added in v1.2.0 

type GetVpcEndpointServiceNameOutput struct {

	// The VPC endpoint service name.
	//
	// This member is required.
	ServiceName *string

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

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ListClustersAPIClient 

type ListClustersAPIClient interface {
	ListClusters(context.Context, *ListClustersInput, ...func(*Options)) (*ListClustersOutput, error)
}

ListClustersAPIClient is a client that implements the ListClusters operation.

type ListClustersInput 

type ListClustersInput struct {

	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to display the next page of results.
	MaxResults *int32

	// If your initial ListClusters operation returns a nextToken, you can include the
	// returned nextToken in following ListClusters operations, which returns results
	// in the next page.
	NextToken *string
	// contains filtered or unexported fields
}

type ListClustersOutput 

type ListClustersOutput struct {

	// An array of the returned clusters.
	//
	// This member is required.
	Clusters []types.ClusterSummary

	// If nextToken is returned, there are more results available. The value of
	// nextToken is a unique pagination token for each page. To retrieve the next page,
	// make the call again using the returned token.
	NextToken *string

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

type ListClustersPaginator 

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

ListClustersPaginator is a paginator for ListClusters

func NewListClustersPaginator 

func NewListClustersPaginator(client ListClustersAPIClient, params *ListClustersInput, optFns ...func(*ListClustersPaginatorOptions)) *ListClustersPaginator

NewListClustersPaginator returns a new ListClustersPaginator

func (*ListClustersPaginator) HasMorePages 

func (p *ListClustersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListClustersPaginator) NextPage 

func (p *ListClustersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListClustersOutput, error)

NextPage retrieves the next ListClusters page.

type ListClustersPaginatorOptions 

type ListClustersPaginatorOptions struct {
	// An optional parameter that specifies the maximum number of results to return.
	// You can use nextToken to display the next page of results.
	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
}

ListClustersPaginatorOptions is the paginator options for ListClusters

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN of the resource for which you want to list the tags.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// A map of key and value pairs that you used to tag your 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

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

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 ARN of the resource that you want to tag.
	//
	// This member is required.
	ResourceArn *string

	// A map of key and value pairs to use to tag your resource.
	//
	// 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 UntagResourceInput struct {

	// The ARN of the resource from which to remove tags.
	//
	// This member is required.
	ResourceArn *string

	// The array of keys of the tags that you want to remove.
	//
	// This member is required.
	TagKeys []string
	// contains filtered or unexported fields
}

type UntagResourceOutput 

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

type UpdateClusterInput 

type UpdateClusterInput struct {

	// The ID of the cluster you want to update.
	//
	// This member is required.
	Identifier *string

	// A unique, case-sensitive identifier that you provide to ensure the idempotency
	// of the request. Idempotency ensures that an API request completes only once.
	// With an idempotent request, if the original request completes successfully. The
	// subsequent retries with the same client token return the result from the
	// original successful request and they have no additional effect.
	//
	// If you don't specify a client token, the Amazon Web Services SDK automatically
	// generates one.
	ClientToken *string

	// Specifies whether to enable deletion protection in your cluster.
	DeletionProtectionEnabled *bool

	// The new multi-Region cluster configuration settings to be applied during an
	// update operation.
	MultiRegionProperties *types.MultiRegionProperties
	// contains filtered or unexported fields
}

type UpdateClusterOutput 

type UpdateClusterOutput struct {

	// The ARN of the updated cluster.
	//
	// This member is required.
	Arn *string

	// The time of when the cluster was created.
	//
	// This member is required.
	CreationTime *time.Time

	// Whether deletion protection is enabled for the updated cluster.
	//
	// This member is required.
	//
	// Deprecated: The deletionProtectionEnabled field is deprecated in the
	// UpdateCluster API. To check deletion protection status, use the GetCluster API
	// instead.
	DeletionProtectionEnabled *bool

	// The ID of the cluster to update.
	//
	// This member is required.
	Identifier *string

	// The status of the updated cluster.
	//
	// This member is required.
	Status types.ClusterStatus

	// The ARNs of the clusters linked to the updated cluster. Applicable only for
	// multi-Region clusters.
	//
	// Deprecated: The linkedClusterArns field is deprecated in the UpdateCluster API.
	// To check peer cluster, use the GetCluster API instead.
	LinkedClusterArns []string

	// The Region that receives all data you write to linked clusters.
	//
	// Deprecated: The witnessRegion field is deprecated in the UpdateCluster API. To
	// check witnessRegion, use the GetCluster API instead.
	WitnessRegion *string

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

The details of the cluster after it has been updated.

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.