route53recoveryreadiness

package module
v1.21.8 Latest Latest
Warning

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

Go to latest
Published: Dec 19, 2024 License: Apache-2.0 Imports: 43 Imported by: 11

Documentation

Overview

Package route53recoveryreadiness provides the API client, operations, and parameter types for AWS Route53 Recovery Readiness.

Recovery readiness

Index

Constants

View Source
const ServiceAPIVersion = "2019-12-02"
View Source
const ServiceID = "Route53 Recovery Readiness"

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.14.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.14.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 AuthResolverParameters added in v1.14.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.14.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 Route53 Recovery Readiness.

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

func (c *Client) CreateCell(ctx context.Context, params *CreateCellInput, optFns ...func(*Options)) (*CreateCellOutput, error)

Creates a cell in an account.

func (*Client) CreateCrossAccountAuthorization

func (c *Client) CreateCrossAccountAuthorization(ctx context.Context, params *CreateCrossAccountAuthorizationInput, optFns ...func(*Options)) (*CreateCrossAccountAuthorizationOutput, error)

Creates a cross-account readiness authorization. This lets you authorize another account to work with Route 53 Application Recovery Controller, for example, to check the readiness status of resources in a separate account.

func (*Client) CreateReadinessCheck

func (c *Client) CreateReadinessCheck(ctx context.Context, params *CreateReadinessCheckInput, optFns ...func(*Options)) (*CreateReadinessCheckOutput, error)

Creates a readiness check in an account. A readiness check monitors a resource set in your application, such as a set of Amazon Aurora instances, that Application Recovery Controller is auditing recovery readiness for. The audits run once every minute on every resource that's associated with a readiness check.

func (*Client) CreateRecoveryGroup

func (c *Client) CreateRecoveryGroup(ctx context.Context, params *CreateRecoveryGroupInput, optFns ...func(*Options)) (*CreateRecoveryGroupOutput, error)

Creates a recovery group in an account. A recovery group corresponds to an application and includes a list of the cells that make up the application.

func (*Client) CreateResourceSet

func (c *Client) CreateResourceSet(ctx context.Context, params *CreateResourceSetInput, optFns ...func(*Options)) (*CreateResourceSetOutput, error)

Creates a resource set. A resource set is a set of resources of one type that span multiple cells. You can associate a resource set with a readiness check to monitor the resources for failover readiness.

func (*Client) DeleteCell

func (c *Client) DeleteCell(ctx context.Context, params *DeleteCellInput, optFns ...func(*Options)) (*DeleteCellOutput, error)

Delete a cell. When successful, the response code is 204, with no response body.

func (*Client) DeleteCrossAccountAuthorization

func (c *Client) DeleteCrossAccountAuthorization(ctx context.Context, params *DeleteCrossAccountAuthorizationInput, optFns ...func(*Options)) (*DeleteCrossAccountAuthorizationOutput, error)

Deletes cross account readiness authorization.

func (*Client) DeleteReadinessCheck

func (c *Client) DeleteReadinessCheck(ctx context.Context, params *DeleteReadinessCheckInput, optFns ...func(*Options)) (*DeleteReadinessCheckOutput, error)

Deletes a readiness check.

func (*Client) DeleteRecoveryGroup

func (c *Client) DeleteRecoveryGroup(ctx context.Context, params *DeleteRecoveryGroupInput, optFns ...func(*Options)) (*DeleteRecoveryGroupOutput, error)

Deletes a recovery group.

func (*Client) DeleteResourceSet

func (c *Client) DeleteResourceSet(ctx context.Context, params *DeleteResourceSetInput, optFns ...func(*Options)) (*DeleteResourceSetOutput, error)

Deletes a resource set.

func (*Client) GetArchitectureRecommendations

func (c *Client) GetArchitectureRecommendations(ctx context.Context, params *GetArchitectureRecommendationsInput, optFns ...func(*Options)) (*GetArchitectureRecommendationsOutput, error)

Gets recommendations about architecture designs for improving resiliency for an application, based on a recovery group.

func (*Client) GetCell

func (c *Client) GetCell(ctx context.Context, params *GetCellInput, optFns ...func(*Options)) (*GetCellOutput, error)

Gets information about a cell including cell name, cell Amazon Resource Name (ARN), ARNs of nested cells for this cell, and a list of those cell ARNs with their associated recovery group ARNs.

func (*Client) GetCellReadinessSummary

func (c *Client) GetCellReadinessSummary(ctx context.Context, params *GetCellReadinessSummaryInput, optFns ...func(*Options)) (*GetCellReadinessSummaryOutput, error)

Gets readiness for a cell. Aggregates the readiness of all the resources that are associated with the cell into a single value.

func (*Client) GetReadinessCheck

func (c *Client) GetReadinessCheck(ctx context.Context, params *GetReadinessCheckInput, optFns ...func(*Options)) (*GetReadinessCheckOutput, error)

Gets details about a readiness check.

func (*Client) GetReadinessCheckResourceStatus

func (c *Client) GetReadinessCheckResourceStatus(ctx context.Context, params *GetReadinessCheckResourceStatusInput, optFns ...func(*Options)) (*GetReadinessCheckResourceStatusOutput, error)

Gets individual readiness status for a readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in the recovery group, use GetRecoveryGroupReadinessSummary.

func (*Client) GetReadinessCheckStatus

func (c *Client) GetReadinessCheckStatus(ctx context.Context, params *GetReadinessCheckStatusInput, optFns ...func(*Options)) (*GetReadinessCheckStatusOutput, error)

Gets the readiness status for an individual readiness check. To see the overall readiness status for a recovery group, that considers the readiness status for all the readiness checks in a recovery group, use GetRecoveryGroupReadinessSummary.

func (*Client) GetRecoveryGroup

func (c *Client) GetRecoveryGroup(ctx context.Context, params *GetRecoveryGroupInput, optFns ...func(*Options)) (*GetRecoveryGroupOutput, error)

Gets details about a recovery group, including a list of the cells that are included in it.

func (*Client) GetRecoveryGroupReadinessSummary

func (c *Client) GetRecoveryGroupReadinessSummary(ctx context.Context, params *GetRecoveryGroupReadinessSummaryInput, optFns ...func(*Options)) (*GetRecoveryGroupReadinessSummaryOutput, error)

Displays a summary of information about a recovery group's readiness status. Includes the readiness checks for resources in the recovery group and the readiness status of each one.

func (*Client) GetResourceSet

func (c *Client) GetResourceSet(ctx context.Context, params *GetResourceSetInput, optFns ...func(*Options)) (*GetResourceSetOutput, error)

Displays the details about a resource set, including a list of the resources in the set.

func (*Client) ListCells

func (c *Client) ListCells(ctx context.Context, params *ListCellsInput, optFns ...func(*Options)) (*ListCellsOutput, error)

Lists the cells for an account.

func (*Client) ListCrossAccountAuthorizations

func (c *Client) ListCrossAccountAuthorizations(ctx context.Context, params *ListCrossAccountAuthorizationsInput, optFns ...func(*Options)) (*ListCrossAccountAuthorizationsOutput, error)

Lists the cross-account readiness authorizations that are in place for an account.

func (*Client) ListReadinessChecks

func (c *Client) ListReadinessChecks(ctx context.Context, params *ListReadinessChecksInput, optFns ...func(*Options)) (*ListReadinessChecksOutput, error)

Lists the readiness checks for an account.

func (*Client) ListRecoveryGroups

func (c *Client) ListRecoveryGroups(ctx context.Context, params *ListRecoveryGroupsInput, optFns ...func(*Options)) (*ListRecoveryGroupsOutput, error)

Lists the recovery groups in an account.

func (*Client) ListResourceSets

func (c *Client) ListResourceSets(ctx context.Context, params *ListResourceSetsInput, optFns ...func(*Options)) (*ListResourceSetsOutput, error)

Lists the resource sets in an account.

func (*Client) ListRules

func (c *Client) ListRules(ctx context.Context, params *ListRulesInput, optFns ...func(*Options)) (*ListRulesOutput, error)

Lists all readiness rules, or lists the readiness rules for a specific resource type.

func (*Client) ListTagsForResources

func (c *Client) ListTagsForResources(ctx context.Context, params *ListTagsForResourcesInput, optFns ...func(*Options)) (*ListTagsForResourcesOutput, error)

Lists the tags for a resource.

func (*Client) Options added in v1.15.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) TagResource

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

Adds a tag to a resource.

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

func (c *Client) UpdateCell(ctx context.Context, params *UpdateCellInput, optFns ...func(*Options)) (*UpdateCellOutput, error)

Updates a cell to replace the list of nested cells with a new list of nested cells.

func (*Client) UpdateReadinessCheck

func (c *Client) UpdateReadinessCheck(ctx context.Context, params *UpdateReadinessCheckInput, optFns ...func(*Options)) (*UpdateReadinessCheckOutput, error)

Updates a readiness check.

func (*Client) UpdateRecoveryGroup

func (c *Client) UpdateRecoveryGroup(ctx context.Context, params *UpdateRecoveryGroupInput, optFns ...func(*Options)) (*UpdateRecoveryGroupOutput, error)

Updates a recovery group.

func (*Client) UpdateResourceSet

func (c *Client) UpdateResourceSet(ctx context.Context, params *UpdateResourceSetInput, optFns ...func(*Options)) (*UpdateResourceSetOutput, error)

Updates a resource set.

type CreateCellInput

type CreateCellInput struct {

	// The name of the cell to create.
	//
	// This member is required.
	CellName *string

	// A list of cell Amazon Resource Names (ARNs) contained within this cell, for use
	// in nested cells. For example, Availability Zones within specific Amazon Web
	// Services Regions.
	Cells []string

	// A collection of tags associated with a resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateCellOutput

type CreateCellOutput struct {

	// The Amazon Resource Name (ARN) for the cell.
	CellArn *string

	// The name of the cell.
	CellName *string

	// A list of cell ARNs.
	Cells []string

	// The readiness scope for the cell, which can be a cell Amazon Resource Name
	// (ARN) or a recovery group ARN. This is a list but currently can have only one
	// element.
	ParentReadinessScopes []string

	// Tags on the resources.
	Tags map[string]string

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

type CreateCrossAccountAuthorizationInput

type CreateCrossAccountAuthorizationInput struct {

	// The cross-account authorization.
	//
	// This member is required.
	CrossAccountAuthorization *string
	// contains filtered or unexported fields
}

type CreateCrossAccountAuthorizationOutput

type CreateCrossAccountAuthorizationOutput struct {

	// The cross-account authorization.
	CrossAccountAuthorization *string

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

type CreateReadinessCheckInput

type CreateReadinessCheckInput struct {

	// The name of the readiness check to create.
	//
	// This member is required.
	ReadinessCheckName *string

	// The name of the resource set to check.
	//
	// This member is required.
	ResourceSetName *string

	// A collection of tags associated with a resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateReadinessCheckOutput

type CreateReadinessCheckOutput struct {

	// The Amazon Resource Name (ARN) associated with a readiness check.
	ReadinessCheckArn *string

	// Name of a readiness check.
	ReadinessCheckName *string

	// Name of the resource set to be checked.
	ResourceSet *string

	// A collection of tags associated with a resource.
	Tags map[string]string

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

type CreateRecoveryGroupInput

type CreateRecoveryGroupInput struct {

	// The name of the recovery group to create.
	//
	// This member is required.
	RecoveryGroupName *string

	// A list of the cell Amazon Resource Names (ARNs) in the recovery group.
	Cells []string

	// A collection of tags associated with a resource.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateRecoveryGroupOutput

type CreateRecoveryGroupOutput struct {

	// A list of a cell's Amazon Resource Names (ARNs).
	Cells []string

	// The Amazon Resource Name (ARN) for the recovery group.
	RecoveryGroupArn *string

	// The name of the recovery group.
	RecoveryGroupName *string

	// The tags associated with the recovery group.
	Tags map[string]string

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

type CreateResourceSetInput

type CreateResourceSetInput struct {

	// The name of the resource set to create.
	//
	// This member is required.
	ResourceSetName *string

	// The resource type of the resources in the resource set. Enter one of the
	// following values for resource type:
	//
	// AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage,
	// AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm,
	// AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume,
	// AWS::ElasticLoadBalancing::LoadBalancer,
	// AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function,
	// AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck,
	// AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC,
	// AWS::EC2::VPNConnection, AWS::EC2::VPNGateway,
	// AWS::Route53RecoveryReadiness::DNSTargetResource
	//
	// This member is required.
	ResourceSetType *string

	// A list of resource objects in the resource set.
	//
	// This member is required.
	Resources []types.Resource

	// A tag to associate with the parameters for a resource set.
	Tags map[string]string
	// contains filtered or unexported fields
}

type CreateResourceSetOutput

type CreateResourceSetOutput struct {

	// The Amazon Resource Name (ARN) for the resource set.
	ResourceSetArn *string

	// The name of the resource set.
	ResourceSetName *string

	// The resource type of the resources in the resource set. Enter one of the
	// following values for resource type:
	//
	// AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage,
	// AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm,
	// AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume,
	// AWS::ElasticLoadBalancing::LoadBalancer,
	// AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function,
	// AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck,
	// AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC,
	// AWS::EC2::VPNConnection, AWS::EC2::VPNGateway,
	// AWS::Route53RecoveryReadiness::DNSTargetResource
	ResourceSetType *string

	// A list of resource objects.
	Resources []types.Resource

	// A collection of tags associated with a resource.
	Tags map[string]string

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

type DeleteCellInput

type DeleteCellInput struct {

	// The name of the cell.
	//
	// This member is required.
	CellName *string
	// contains filtered or unexported fields
}

type DeleteCellOutput

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

type DeleteCrossAccountAuthorizationInput

type DeleteCrossAccountAuthorizationInput struct {

	// The cross-account authorization.
	//
	// This member is required.
	CrossAccountAuthorization *string
	// contains filtered or unexported fields
}

type DeleteCrossAccountAuthorizationOutput

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

type DeleteReadinessCheckInput

type DeleteReadinessCheckInput struct {

	// Name of a readiness check.
	//
	// This member is required.
	ReadinessCheckName *string
	// contains filtered or unexported fields
}

type DeleteReadinessCheckOutput

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

type DeleteRecoveryGroupInput

type DeleteRecoveryGroupInput struct {

	// The name of a recovery group.
	//
	// This member is required.
	RecoveryGroupName *string
	// contains filtered or unexported fields
}

type DeleteRecoveryGroupOutput

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

type DeleteResourceSetInput

type DeleteResourceSetInput struct {

	// Name of a resource set.
	//
	// This member is required.
	ResourceSetName *string
	// contains filtered or unexported fields
}

type DeleteResourceSetOutput

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

type GetArchitectureRecommendationsInput struct {

	// The name of a recovery group.
	//
	// This member is required.
	RecoveryGroupName *string

	// The number of objects that you want to return with this call.
	MaxResults *int32

	// The token that identifies which batch of results you want to see.
	NextToken *string
	// contains filtered or unexported fields
}

type GetArchitectureRecommendationsOutput

type GetArchitectureRecommendationsOutput struct {

	// The time that a recovery group was last assessed for recommendations, in UTC
	// ISO-8601 format.
	LastAuditTimestamp *time.Time

	// The token that identifies which batch of results you want to see.
	NextToken *string

	// A list of the recommendations for the customer's application.
	Recommendations []types.Recommendation

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

type GetCellInput

type GetCellInput struct {

	// The name of the cell.
	//
	// This member is required.
	CellName *string
	// contains filtered or unexported fields
}

type GetCellOutput

type GetCellOutput struct {

	// The Amazon Resource Name (ARN) for the cell.
	CellArn *string

	// The name of the cell.
	CellName *string

	// A list of cell ARNs.
	Cells []string

	// The readiness scope for the cell, which can be a cell Amazon Resource Name
	// (ARN) or a recovery group ARN. This is a list but currently can have only one
	// element.
	ParentReadinessScopes []string

	// Tags on the resources.
	Tags map[string]string

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

type GetCellReadinessSummaryAPIClient

type GetCellReadinessSummaryAPIClient interface {
	GetCellReadinessSummary(context.Context, *GetCellReadinessSummaryInput, ...func(*Options)) (*GetCellReadinessSummaryOutput, error)
}

GetCellReadinessSummaryAPIClient is a client that implements the GetCellReadinessSummary operation.

type GetCellReadinessSummaryInput

type GetCellReadinessSummaryInput struct {

	// The name of the cell.
	//
	// This member is required.
	CellName *string

	// The number of objects that you want to return with this call.
	MaxResults *int32

	// The token that identifies which batch of results you want to see.
	NextToken *string
	// contains filtered or unexported fields
}

type GetCellReadinessSummaryOutput

type GetCellReadinessSummaryOutput struct {

	// The token that identifies which batch of results you want to see.
	NextToken *string

	// The readiness at a cell level.
	Readiness types.Readiness

	// Summaries for the readiness checks that make up the cell.
	ReadinessChecks []types.ReadinessCheckSummary

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

type GetCellReadinessSummaryPaginator

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

GetCellReadinessSummaryPaginator is a paginator for GetCellReadinessSummary

func NewGetCellReadinessSummaryPaginator

NewGetCellReadinessSummaryPaginator returns a new GetCellReadinessSummaryPaginator

func (*GetCellReadinessSummaryPaginator) HasMorePages

func (p *GetCellReadinessSummaryPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetCellReadinessSummaryPaginator) NextPage

NextPage retrieves the next GetCellReadinessSummary page.

type GetCellReadinessSummaryPaginatorOptions

type GetCellReadinessSummaryPaginatorOptions struct {
	// The number of objects that you want to return with this call.
	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
}

GetCellReadinessSummaryPaginatorOptions is the paginator options for GetCellReadinessSummary

type GetReadinessCheckInput

type GetReadinessCheckInput struct {

	// Name of a readiness check.
	//
	// This member is required.
	ReadinessCheckName *string
	// contains filtered or unexported fields
}

type GetReadinessCheckOutput

type GetReadinessCheckOutput struct {

	// The Amazon Resource Name (ARN) associated with a readiness check.
	ReadinessCheckArn *string

	// Name of a readiness check.
	ReadinessCheckName *string

	// Name of the resource set to be checked.
	ResourceSet *string

	// A collection of tags associated with a resource.
	Tags map[string]string

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

type GetReadinessCheckResourceStatusAPIClient

type GetReadinessCheckResourceStatusAPIClient interface {
	GetReadinessCheckResourceStatus(context.Context, *GetReadinessCheckResourceStatusInput, ...func(*Options)) (*GetReadinessCheckResourceStatusOutput, error)
}

GetReadinessCheckResourceStatusAPIClient is a client that implements the GetReadinessCheckResourceStatus operation.

type GetReadinessCheckResourceStatusInput

type GetReadinessCheckResourceStatusInput struct {

	// Name of a readiness check.
	//
	// This member is required.
	ReadinessCheckName *string

	// The resource identifier, which is the Amazon Resource Name (ARN) or the
	// identifier generated for the resource by Application Recovery Controller (for
	// example, for a DNS target resource).
	//
	// This member is required.
	ResourceIdentifier *string

	// The number of objects that you want to return with this call.
	MaxResults *int32

	// The token that identifies which batch of results you want to see.
	NextToken *string
	// contains filtered or unexported fields
}

type GetReadinessCheckResourceStatusOutput

type GetReadinessCheckResourceStatusOutput struct {

	// The token that identifies which batch of results you want to see.
	NextToken *string

	// The readiness at a rule level.
	Readiness types.Readiness

	// Details of the rule's results.
	Rules []types.RuleResult

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

type GetReadinessCheckResourceStatusPaginator

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

GetReadinessCheckResourceStatusPaginator is a paginator for GetReadinessCheckResourceStatus

func NewGetReadinessCheckResourceStatusPaginator

NewGetReadinessCheckResourceStatusPaginator returns a new GetReadinessCheckResourceStatusPaginator

func (*GetReadinessCheckResourceStatusPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*GetReadinessCheckResourceStatusPaginator) NextPage

NextPage retrieves the next GetReadinessCheckResourceStatus page.

type GetReadinessCheckResourceStatusPaginatorOptions

type GetReadinessCheckResourceStatusPaginatorOptions struct {
	// The number of objects that you want to return with this call.
	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
}

GetReadinessCheckResourceStatusPaginatorOptions is the paginator options for GetReadinessCheckResourceStatus

type GetReadinessCheckStatusAPIClient

type GetReadinessCheckStatusAPIClient interface {
	GetReadinessCheckStatus(context.Context, *GetReadinessCheckStatusInput, ...func(*Options)) (*GetReadinessCheckStatusOutput, error)
}

GetReadinessCheckStatusAPIClient is a client that implements the GetReadinessCheckStatus operation.

type GetReadinessCheckStatusInput

type GetReadinessCheckStatusInput struct {

	// Name of a readiness check.
	//
	// This member is required.
	ReadinessCheckName *string

	// The number of objects that you want to return with this call.
	MaxResults *int32

	// The token that identifies which batch of results you want to see.
	NextToken *string
	// contains filtered or unexported fields
}

type GetReadinessCheckStatusOutput

type GetReadinessCheckStatusOutput struct {

	// Top level messages for readiness check status
	Messages []types.Message

	// The token that identifies which batch of results you want to see.
	NextToken *string

	// The readiness at rule level.
	Readiness types.Readiness

	// Summary of the readiness of resources.
	Resources []types.ResourceResult

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

type GetReadinessCheckStatusPaginator

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

GetReadinessCheckStatusPaginator is a paginator for GetReadinessCheckStatus

func NewGetReadinessCheckStatusPaginator

NewGetReadinessCheckStatusPaginator returns a new GetReadinessCheckStatusPaginator

func (*GetReadinessCheckStatusPaginator) HasMorePages

func (p *GetReadinessCheckStatusPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetReadinessCheckStatusPaginator) NextPage

NextPage retrieves the next GetReadinessCheckStatus page.

type GetReadinessCheckStatusPaginatorOptions

type GetReadinessCheckStatusPaginatorOptions struct {
	// The number of objects that you want to return with this call.
	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
}

GetReadinessCheckStatusPaginatorOptions is the paginator options for GetReadinessCheckStatus

type GetRecoveryGroupInput

type GetRecoveryGroupInput struct {

	// The name of a recovery group.
	//
	// This member is required.
	RecoveryGroupName *string
	// contains filtered or unexported fields
}

type GetRecoveryGroupOutput

type GetRecoveryGroupOutput struct {

	// A list of a cell's Amazon Resource Names (ARNs).
	Cells []string

	// The Amazon Resource Name (ARN) for the recovery group.
	RecoveryGroupArn *string

	// The name of the recovery group.
	RecoveryGroupName *string

	// The tags associated with the recovery group.
	Tags map[string]string

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

type GetRecoveryGroupReadinessSummaryAPIClient

type GetRecoveryGroupReadinessSummaryAPIClient interface {
	GetRecoveryGroupReadinessSummary(context.Context, *GetRecoveryGroupReadinessSummaryInput, ...func(*Options)) (*GetRecoveryGroupReadinessSummaryOutput, error)
}

GetRecoveryGroupReadinessSummaryAPIClient is a client that implements the GetRecoveryGroupReadinessSummary operation.

type GetRecoveryGroupReadinessSummaryInput

type GetRecoveryGroupReadinessSummaryInput struct {

	// The name of a recovery group.
	//
	// This member is required.
	RecoveryGroupName *string

	// The number of objects that you want to return with this call.
	MaxResults *int32

	// The token that identifies which batch of results you want to see.
	NextToken *string
	// contains filtered or unexported fields
}

type GetRecoveryGroupReadinessSummaryOutput

type GetRecoveryGroupReadinessSummaryOutput struct {

	// The token that identifies which batch of results you want to see.
	NextToken *string

	// The readiness status at a recovery group level.
	Readiness types.Readiness

	// Summaries of the readiness checks for the recovery group.
	ReadinessChecks []types.ReadinessCheckSummary

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

type GetRecoveryGroupReadinessSummaryPaginator

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

GetRecoveryGroupReadinessSummaryPaginator is a paginator for GetRecoveryGroupReadinessSummary

func NewGetRecoveryGroupReadinessSummaryPaginator

NewGetRecoveryGroupReadinessSummaryPaginator returns a new GetRecoveryGroupReadinessSummaryPaginator

func (*GetRecoveryGroupReadinessSummaryPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*GetRecoveryGroupReadinessSummaryPaginator) NextPage

NextPage retrieves the next GetRecoveryGroupReadinessSummary page.

type GetRecoveryGroupReadinessSummaryPaginatorOptions

type GetRecoveryGroupReadinessSummaryPaginatorOptions struct {
	// The number of objects that you want to return with this call.
	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
}

GetRecoveryGroupReadinessSummaryPaginatorOptions is the paginator options for GetRecoveryGroupReadinessSummary

type GetResourceSetInput

type GetResourceSetInput struct {

	// Name of a resource set.
	//
	// This member is required.
	ResourceSetName *string
	// contains filtered or unexported fields
}

type GetResourceSetOutput

type GetResourceSetOutput struct {

	// The Amazon Resource Name (ARN) for the resource set.
	ResourceSetArn *string

	// The name of the resource set.
	ResourceSetName *string

	// The resource type of the resources in the resource set. Enter one of the
	// following values for resource type:
	//
	// AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage,
	// AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm,
	// AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume,
	// AWS::ElasticLoadBalancing::LoadBalancer,
	// AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function,
	// AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck,
	// AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC,
	// AWS::EC2::VPNConnection, AWS::EC2::VPNGateway,
	// AWS::Route53RecoveryReadiness::DNSTargetResource
	ResourceSetType *string

	// A list of resource objects.
	Resources []types.Resource

	// A collection of tags associated with a resource.
	Tags map[string]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 ListCellsAPIClient

type ListCellsAPIClient interface {
	ListCells(context.Context, *ListCellsInput, ...func(*Options)) (*ListCellsOutput, error)
}

ListCellsAPIClient is a client that implements the ListCells operation.

type ListCellsInput

type ListCellsInput struct {

	// The number of objects that you want to return with this call.
	MaxResults *int32

	// The token that identifies which batch of results you want to see.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCellsOutput

type ListCellsOutput struct {

	// A list of cells.
	Cells []types.CellOutput

	// The token that identifies which batch of results you want to see.
	NextToken *string

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

type ListCellsPaginator

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

ListCellsPaginator is a paginator for ListCells

func NewListCellsPaginator

func NewListCellsPaginator(client ListCellsAPIClient, params *ListCellsInput, optFns ...func(*ListCellsPaginatorOptions)) *ListCellsPaginator

NewListCellsPaginator returns a new ListCellsPaginator

func (*ListCellsPaginator) HasMorePages

func (p *ListCellsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCellsPaginator) NextPage

func (p *ListCellsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCellsOutput, error)

NextPage retrieves the next ListCells page.

type ListCellsPaginatorOptions

type ListCellsPaginatorOptions struct {
	// The number of objects that you want to return with this call.
	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
}

ListCellsPaginatorOptions is the paginator options for ListCells

type ListCrossAccountAuthorizationsAPIClient

type ListCrossAccountAuthorizationsAPIClient interface {
	ListCrossAccountAuthorizations(context.Context, *ListCrossAccountAuthorizationsInput, ...func(*Options)) (*ListCrossAccountAuthorizationsOutput, error)
}

ListCrossAccountAuthorizationsAPIClient is a client that implements the ListCrossAccountAuthorizations operation.

type ListCrossAccountAuthorizationsInput

type ListCrossAccountAuthorizationsInput struct {

	// The number of objects that you want to return with this call.
	MaxResults *int32

	// The token that identifies which batch of results you want to see.
	NextToken *string
	// contains filtered or unexported fields
}

type ListCrossAccountAuthorizationsOutput

type ListCrossAccountAuthorizationsOutput struct {

	// A list of cross-account authorizations.
	CrossAccountAuthorizations []string

	// The token that identifies which batch of results you want to see.
	NextToken *string

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

type ListCrossAccountAuthorizationsPaginator

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

ListCrossAccountAuthorizationsPaginator is a paginator for ListCrossAccountAuthorizations

func NewListCrossAccountAuthorizationsPaginator

NewListCrossAccountAuthorizationsPaginator returns a new ListCrossAccountAuthorizationsPaginator

func (*ListCrossAccountAuthorizationsPaginator) HasMorePages

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCrossAccountAuthorizationsPaginator) NextPage

NextPage retrieves the next ListCrossAccountAuthorizations page.

type ListCrossAccountAuthorizationsPaginatorOptions

type ListCrossAccountAuthorizationsPaginatorOptions struct {
	// The number of objects that you want to return with this call.
	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
}

ListCrossAccountAuthorizationsPaginatorOptions is the paginator options for ListCrossAccountAuthorizations

type ListReadinessChecksAPIClient

type ListReadinessChecksAPIClient interface {
	ListReadinessChecks(context.Context, *ListReadinessChecksInput, ...func(*Options)) (*ListReadinessChecksOutput, error)
}

ListReadinessChecksAPIClient is a client that implements the ListReadinessChecks operation.

type ListReadinessChecksInput

type ListReadinessChecksInput struct {

	// The number of objects that you want to return with this call.
	MaxResults *int32

	// The token that identifies which batch of results you want to see.
	NextToken *string
	// contains filtered or unexported fields
}

type ListReadinessChecksOutput

type ListReadinessChecksOutput struct {

	// The token that identifies which batch of results you want to see.
	NextToken *string

	// A list of readiness checks associated with the account.
	ReadinessChecks []types.ReadinessCheckOutput

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

type ListReadinessChecksPaginator

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

ListReadinessChecksPaginator is a paginator for ListReadinessChecks

func NewListReadinessChecksPaginator

func NewListReadinessChecksPaginator(client ListReadinessChecksAPIClient, params *ListReadinessChecksInput, optFns ...func(*ListReadinessChecksPaginatorOptions)) *ListReadinessChecksPaginator

NewListReadinessChecksPaginator returns a new ListReadinessChecksPaginator

func (*ListReadinessChecksPaginator) HasMorePages

func (p *ListReadinessChecksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListReadinessChecksPaginator) NextPage

func (p *ListReadinessChecksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListReadinessChecksOutput, error)

NextPage retrieves the next ListReadinessChecks page.

type ListReadinessChecksPaginatorOptions

type ListReadinessChecksPaginatorOptions struct {
	// The number of objects that you want to return with this call.
	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
}

ListReadinessChecksPaginatorOptions is the paginator options for ListReadinessChecks

type ListRecoveryGroupsAPIClient

type ListRecoveryGroupsAPIClient interface {
	ListRecoveryGroups(context.Context, *ListRecoveryGroupsInput, ...func(*Options)) (*ListRecoveryGroupsOutput, error)
}

ListRecoveryGroupsAPIClient is a client that implements the ListRecoveryGroups operation.

type ListRecoveryGroupsInput

type ListRecoveryGroupsInput struct {

	// The number of objects that you want to return with this call.
	MaxResults *int32

	// The token that identifies which batch of results you want to see.
	NextToken *string
	// contains filtered or unexported fields
}

type ListRecoveryGroupsOutput

type ListRecoveryGroupsOutput struct {

	// The token that identifies which batch of results you want to see.
	NextToken *string

	// A list of recovery groups.
	RecoveryGroups []types.RecoveryGroupOutput

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

type ListRecoveryGroupsPaginator

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

ListRecoveryGroupsPaginator is a paginator for ListRecoveryGroups

func NewListRecoveryGroupsPaginator

func NewListRecoveryGroupsPaginator(client ListRecoveryGroupsAPIClient, params *ListRecoveryGroupsInput, optFns ...func(*ListRecoveryGroupsPaginatorOptions)) *ListRecoveryGroupsPaginator

NewListRecoveryGroupsPaginator returns a new ListRecoveryGroupsPaginator

func (*ListRecoveryGroupsPaginator) HasMorePages

func (p *ListRecoveryGroupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRecoveryGroupsPaginator) NextPage

func (p *ListRecoveryGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecoveryGroupsOutput, error)

NextPage retrieves the next ListRecoveryGroups page.

type ListRecoveryGroupsPaginatorOptions

type ListRecoveryGroupsPaginatorOptions struct {
	// The number of objects that you want to return with this call.
	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
}

ListRecoveryGroupsPaginatorOptions is the paginator options for ListRecoveryGroups

type ListResourceSetsAPIClient

type ListResourceSetsAPIClient interface {
	ListResourceSets(context.Context, *ListResourceSetsInput, ...func(*Options)) (*ListResourceSetsOutput, error)
}

ListResourceSetsAPIClient is a client that implements the ListResourceSets operation.

type ListResourceSetsInput

type ListResourceSetsInput struct {

	// The number of objects that you want to return with this call.
	MaxResults *int32

	// The token that identifies which batch of results you want to see.
	NextToken *string
	// contains filtered or unexported fields
}

type ListResourceSetsOutput

type ListResourceSetsOutput struct {

	// The token that identifies which batch of results you want to see.
	NextToken *string

	// A list of resource sets associated with the account.
	ResourceSets []types.ResourceSetOutput

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

type ListResourceSetsPaginator

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

ListResourceSetsPaginator is a paginator for ListResourceSets

func NewListResourceSetsPaginator

func NewListResourceSetsPaginator(client ListResourceSetsAPIClient, params *ListResourceSetsInput, optFns ...func(*ListResourceSetsPaginatorOptions)) *ListResourceSetsPaginator

NewListResourceSetsPaginator returns a new ListResourceSetsPaginator

func (*ListResourceSetsPaginator) HasMorePages

func (p *ListResourceSetsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListResourceSetsPaginator) NextPage

func (p *ListResourceSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourceSetsOutput, error)

NextPage retrieves the next ListResourceSets page.

type ListResourceSetsPaginatorOptions

type ListResourceSetsPaginatorOptions struct {
	// The number of objects that you want to return with this call.
	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
}

ListResourceSetsPaginatorOptions is the paginator options for ListResourceSets

type ListRulesAPIClient

type ListRulesAPIClient interface {
	ListRules(context.Context, *ListRulesInput, ...func(*Options)) (*ListRulesOutput, error)
}

ListRulesAPIClient is a client that implements the ListRules operation.

type ListRulesInput

type ListRulesInput struct {

	// The number of objects that you want to return with this call.
	MaxResults *int32

	// The token that identifies which batch of results you want to see.
	NextToken *string

	// The resource type that a readiness rule applies to.
	ResourceType *string
	// contains filtered or unexported fields
}

type ListRulesOutput

type ListRulesOutput struct {

	// The token that identifies which batch of results you want to see.
	NextToken *string

	// A list of readiness rules for a specific resource type.
	Rules []types.ListRulesOutput

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

type ListRulesPaginator

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

ListRulesPaginator is a paginator for ListRules

func NewListRulesPaginator

func NewListRulesPaginator(client ListRulesAPIClient, params *ListRulesInput, optFns ...func(*ListRulesPaginatorOptions)) *ListRulesPaginator

NewListRulesPaginator returns a new ListRulesPaginator

func (*ListRulesPaginator) HasMorePages

func (p *ListRulesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListRulesPaginator) NextPage

func (p *ListRulesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRulesOutput, error)

NextPage retrieves the next ListRules page.

type ListRulesPaginatorOptions

type ListRulesPaginatorOptions struct {
	// The number of objects that you want to return with this call.
	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
}

ListRulesPaginatorOptions is the paginator options for ListRules

type ListTagsForResourcesInput

type ListTagsForResourcesInput struct {

	// The Amazon Resource Name (ARN) for a resource.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourcesOutput

type ListTagsForResourcesOutput struct {

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

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

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

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) for a resource.
	//
	// This member is required.
	ResourceArn *string

	//
	//
	// 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 Amazon Resource Name (ARN) for a resource.
	//
	// This member is required.
	ResourceArn *string

	// The keys for tags you add to resources.
	//
	// 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 UpdateCellInput

type UpdateCellInput struct {

	// The name of the cell.
	//
	// This member is required.
	CellName *string

	// A list of cell Amazon Resource Names (ARNs), which completely replaces the
	// previous list.
	//
	// This member is required.
	Cells []string
	// contains filtered or unexported fields
}

type UpdateCellOutput

type UpdateCellOutput struct {

	// The Amazon Resource Name (ARN) for the cell.
	CellArn *string

	// The name of the cell.
	CellName *string

	// A list of cell ARNs.
	Cells []string

	// The readiness scope for the cell, which can be a cell Amazon Resource Name
	// (ARN) or a recovery group ARN. This is a list but currently can have only one
	// element.
	ParentReadinessScopes []string

	// Tags on the resources.
	Tags map[string]string

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

type UpdateReadinessCheckInput

type UpdateReadinessCheckInput struct {

	// Name of a readiness check.
	//
	// This member is required.
	ReadinessCheckName *string

	// The name of the resource set to be checked.
	//
	// This member is required.
	ResourceSetName *string
	// contains filtered or unexported fields
}

Name of a readiness check to describe.

type UpdateReadinessCheckOutput

type UpdateReadinessCheckOutput struct {

	// The Amazon Resource Name (ARN) associated with a readiness check.
	ReadinessCheckArn *string

	// Name of a readiness check.
	ReadinessCheckName *string

	// Name of the resource set to be checked.
	ResourceSet *string

	// A collection of tags associated with a resource.
	Tags map[string]string

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

type UpdateRecoveryGroupInput

type UpdateRecoveryGroupInput struct {

	// A list of cell Amazon Resource Names (ARNs). This list completely replaces the
	// previous list.
	//
	// This member is required.
	Cells []string

	// The name of a recovery group.
	//
	// This member is required.
	RecoveryGroupName *string
	// contains filtered or unexported fields
}

Name of a recovery group.

type UpdateRecoveryGroupOutput

type UpdateRecoveryGroupOutput struct {

	// A list of a cell's Amazon Resource Names (ARNs).
	Cells []string

	// The Amazon Resource Name (ARN) for the recovery group.
	RecoveryGroupArn *string

	// The name of the recovery group.
	RecoveryGroupName *string

	// The tags associated with the recovery group.
	Tags map[string]string

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

type UpdateResourceSetInput

type UpdateResourceSetInput struct {

	// Name of a resource set.
	//
	// This member is required.
	ResourceSetName *string

	// The resource type of the resources in the resource set. Enter one of the
	// following values for resource type:
	//
	// AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage,
	// AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm,
	// AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume,
	// AWS::ElasticLoadBalancing::LoadBalancer,
	// AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function,
	// AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck,
	// AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC,
	// AWS::EC2::VPNConnection, AWS::EC2::VPNGateway,
	// AWS::Route53RecoveryReadiness::DNSTargetResource
	//
	// This member is required.
	ResourceSetType *string

	// A list of resource objects.
	//
	// This member is required.
	Resources []types.Resource
	// contains filtered or unexported fields
}

Name of a resource set.

type UpdateResourceSetOutput

type UpdateResourceSetOutput struct {

	// The Amazon Resource Name (ARN) for the resource set.
	ResourceSetArn *string

	// The name of the resource set.
	ResourceSetName *string

	// The resource type of the resources in the resource set. Enter one of the
	// following values for resource type:
	//
	// AWS::ApiGateway::Stage, AWS::ApiGatewayV2::Stage,
	// AWS::AutoScaling::AutoScalingGroup, AWS::CloudWatch::Alarm,
	// AWS::EC2::CustomerGateway, AWS::DynamoDB::Table, AWS::EC2::Volume,
	// AWS::ElasticLoadBalancing::LoadBalancer,
	// AWS::ElasticLoadBalancingV2::LoadBalancer, AWS::Lambda::Function,
	// AWS::MSK::Cluster, AWS::RDS::DBCluster, AWS::Route53::HealthCheck,
	// AWS::SQS::Queue, AWS::SNS::Topic, AWS::SNS::Subscription, AWS::EC2::VPC,
	// AWS::EC2::VPNConnection, AWS::EC2::VPNGateway,
	// AWS::Route53RecoveryReadiness::DNSTargetResource
	ResourceSetType *string

	// A list of resource objects.
	Resources []types.Resource

	// A collection of tags associated with a resource.
	Tags map[string]string

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

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL