docdbelastic

package
v1.54.7 Latest Latest
Warning

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

 Go to latest Published: Jun 24, 2024 License: Apache-2.0 Imports: 9 Imported by: 6

Documentation

Overview

Package docdbelastic provides the client and types for making API requests to Amazon DocumentDB Elastic Clusters.

Amazon DocumentDB elastic-clusters support workloads with millions of reads/writes per second and petabytes of storage capacity. Amazon DocumentDB elastic clusters also simplify how developers interact with Amazon DocumentDB elastic-clusters by eliminating the need to choose, manage or upgrade instances.

Amazon DocumentDB elastic-clusters were created to:

  • provide a solution for customers looking for a database that provides virtually limitless scale with rich query capabilities and MongoDB API compatibility.

  • give customers higher connection limits, and to reduce downtime from patching.

  • continue investing in a cloud-native, elastic, and class leading architecture for JSON workloads.

See https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28 for more information on this service.

See docdbelastic package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/docdbelastic/

Using the Client

To contact Amazon DocumentDB Elastic Clusters with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon DocumentDB Elastic Clusters client DocDBElastic for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/docdbelastic/#New

Index

Constants

View Source 
const (
	// AuthPlainText is a Auth enum value
	AuthPlainText = "PLAIN_TEXT"

	// AuthSecretArn is a Auth enum value
	AuthSecretArn = "SECRET_ARN"
)
View Source 
const (
	// SnapshotTypeManual is a SnapshotType enum value
	SnapshotTypeManual = "MANUAL"

	// SnapshotTypeAutomated is a SnapshotType enum value
	SnapshotTypeAutomated = "AUTOMATED"
)
View Source 
const (
	// StatusCreating is a Status enum value
	StatusCreating = "CREATING"

	// StatusActive is a Status enum value
	StatusActive = "ACTIVE"

	// StatusDeleting is a Status enum value
	StatusDeleting = "DELETING"

	// StatusUpdating is a Status enum value
	StatusUpdating = "UPDATING"

	// StatusVpcEndpointLimitExceeded is a Status enum value
	StatusVpcEndpointLimitExceeded = "VPC_ENDPOINT_LIMIT_EXCEEDED"

	// StatusIpAddressLimitExceeded is a Status enum value
	StatusIpAddressLimitExceeded = "IP_ADDRESS_LIMIT_EXCEEDED"

	// StatusInvalidSecurityGroupId is a Status enum value
	StatusInvalidSecurityGroupId = "INVALID_SECURITY_GROUP_ID"

	// StatusInvalidSubnetId is a Status enum value
	StatusInvalidSubnetId = "INVALID_SUBNET_ID"

	// StatusInaccessibleEncryptionCreds is a Status enum value
	StatusInaccessibleEncryptionCreds = "INACCESSIBLE_ENCRYPTION_CREDS"

	// StatusInaccessibleSecretArn is a Status enum value
	StatusInaccessibleSecretArn = "INACCESSIBLE_SECRET_ARN"

	// StatusInaccessibleVpcEndpoint is a Status enum value
	StatusInaccessibleVpcEndpoint = "INACCESSIBLE_VPC_ENDPOINT"

	// StatusIncompatibleNetwork is a Status enum value
	StatusIncompatibleNetwork = "INCOMPATIBLE_NETWORK"

	// StatusMerging is a Status enum value
	StatusMerging = "MERGING"

	// StatusModifying is a Status enum value
	StatusModifying = "MODIFYING"

	// StatusSplitting is a Status enum value
	StatusSplitting = "SPLITTING"

	// StatusCopying is a Status enum value
	StatusCopying = "COPYING"

	// StatusStarting is a Status enum value
	StatusStarting = "STARTING"

	// StatusStopping is a Status enum value
	StatusStopping = "STOPPING"

	// StatusStopped is a Status enum value
	StatusStopped = "STOPPED"
)
View Source 
const (
	// ValidationExceptionReasonUnknownOperation is a ValidationExceptionReason enum value
	ValidationExceptionReasonUnknownOperation = "unknownOperation"

	// ValidationExceptionReasonCannotParse is a ValidationExceptionReason enum value
	ValidationExceptionReasonCannotParse = "cannotParse"

	// ValidationExceptionReasonFieldValidationFailed is a ValidationExceptionReason enum value
	ValidationExceptionReasonFieldValidationFailed = "fieldValidationFailed"

	// ValidationExceptionReasonOther is a ValidationExceptionReason enum value
	ValidationExceptionReasonOther = "other"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// An exception that occurs when there are not sufficient permissions to perform
	// an action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// There was an access conflict.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// There was an internal server error.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource could not be located.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The service quota for the action was exceeded.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// ThrottlingException will be thrown when request was denied due to request
	// throttling.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// A structure defining a validation exception.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "DocDB Elastic" // Name of service.
	EndpointsID = "docdb-elastic" // ID to lookup a service endpoint with.
	ServiceID   = "DocDB Elastic" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func Auth_Values 

func Auth_Values() []string

Auth_Values returns all elements of the Auth enum

func SnapshotType_Values added in v1.50.29 

func SnapshotType_Values() []string

SnapshotType_Values returns all elements of the SnapshotType enum

func Status_Values 

func Status_Values() []string

Status_Values returns all elements of the Status enum

func ValidationExceptionReason_Values 

func ValidationExceptionReason_Values() []string

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum

Types

type AccessDeniedException 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// An error message explaining why access was denied.
	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

An exception that occurs when there are not sufficient permissions to perform an action.

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Cluster 

type Cluster struct {

	// The name of the elastic cluster administrator.
	//
	// AdminUserName is a required field
	AdminUserName *string `locationName:"adminUserName" type:"string" required:"true"`

	// The authentication type for the elastic cluster.
	//
	// AuthType is a required field
	AuthType *string `locationName:"authType" type:"string" required:"true" enum:"Auth"`

	// The number of days for which automatic snapshots are retained.
	BackupRetentionPeriod *int64 `locationName:"backupRetentionPeriod" type:"integer"`

	// The ARN identifier of the elastic cluster.
	//
	// ClusterArn is a required field
	ClusterArn *string `locationName:"clusterArn" type:"string" required:"true"`

	// The URL used to connect to the elastic cluster.
	//
	// ClusterEndpoint is a required field
	ClusterEndpoint *string `locationName:"clusterEndpoint" type:"string" required:"true"`

	// The name of the elastic cluster.
	//
	// ClusterName is a required field
	ClusterName *string `locationName:"clusterName" type:"string" required:"true"`

	// The time when the elastic cluster was created in Universal Coordinated Time
	// (UTC).
	//
	// CreateTime is a required field
	CreateTime *string `locationName:"createTime" type:"string" required:"true"`

	// The KMS key identifier to use to encrypt the elastic cluster.
	//
	// KmsKeyId is a required field
	KmsKeyId *string `locationName:"kmsKeyId" type:"string" required:"true"`

	// The daily time range during which automated backups are created if automated
	// backups are enabled, as determined by backupRetentionPeriod.
	PreferredBackupWindow *string `locationName:"preferredBackupWindow" type:"string"`

	// The weekly time range during which system maintenance can occur, in Universal
	// Coordinated Time (UTC).
	//
	// Format: ddd:hh24:mi-ddd:hh24:mi
	//
	// PreferredMaintenanceWindow is a required field
	PreferredMaintenanceWindow *string `locationName:"preferredMaintenanceWindow" type:"string" required:"true"`

	// The number of vCPUs assigned to each elastic cluster shard. Maximum is 64.
	// Allowed values are 2, 4, 8, 16, 32, 64.
	//
	// ShardCapacity is a required field
	ShardCapacity *int64 `locationName:"shardCapacity" type:"integer" required:"true"`

	// The number of shards assigned to the elastic cluster. Maximum is 32.
	//
	// ShardCount is a required field
	ShardCount *int64 `locationName:"shardCount" type:"integer" required:"true"`

	// The number of replica instances applying to all shards in the cluster. A
	// shardInstanceCount value of 1 means there is one writer instance, and any
	// additional instances are replicas that can be used for reads and to improve
	// availability.
	ShardInstanceCount *int64 `locationName:"shardInstanceCount" type:"integer"`

	// The total number of shards in the cluster.
	Shards []*Shard `locationName:"shards" type:"list"`

	// The status of the elastic cluster.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"Status"`

	// The Amazon EC2 subnet IDs for the elastic cluster.
	//
	// SubnetIds is a required field
	SubnetIds []*string `locationName:"subnetIds" type:"list" required:"true"`

	// A list of EC2 VPC security groups associated with thie elastic cluster.
	//
	// VpcSecurityGroupIds is a required field
	VpcSecurityGroupIds []*string `locationName:"vpcSecurityGroupIds" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Returns information about a specific elastic cluster.

func (Cluster) GoString 

func (s Cluster) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Cluster) SetAdminUserName 

func (s *Cluster) SetAdminUserName(v string) *Cluster

SetAdminUserName sets the AdminUserName field's value.

func (*Cluster) SetAuthType 

func (s *Cluster) SetAuthType(v string) *Cluster

SetAuthType sets the AuthType field's value.

func (*Cluster) SetBackupRetentionPeriod added in v1.50.29 

func (s *Cluster) SetBackupRetentionPeriod(v int64) *Cluster

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*Cluster) SetClusterArn 

func (s *Cluster) SetClusterArn(v string) *Cluster

SetClusterArn sets the ClusterArn field's value.

func (*Cluster) SetClusterEndpoint 

func (s *Cluster) SetClusterEndpoint(v string) *Cluster

SetClusterEndpoint sets the ClusterEndpoint field's value.

func (*Cluster) SetClusterName 

func (s *Cluster) SetClusterName(v string) *Cluster

SetClusterName sets the ClusterName field's value.

func (*Cluster) SetCreateTime 

func (s *Cluster) SetCreateTime(v string) *Cluster

SetCreateTime sets the CreateTime field's value.

func (*Cluster) SetKmsKeyId 

func (s *Cluster) SetKmsKeyId(v string) *Cluster

SetKmsKeyId sets the KmsKeyId field's value.

func (*Cluster) SetPreferredBackupWindow added in v1.50.29 

func (s *Cluster) SetPreferredBackupWindow(v string) *Cluster

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*Cluster) SetPreferredMaintenanceWindow 

func (s *Cluster) SetPreferredMaintenanceWindow(v string) *Cluster

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*Cluster) SetShardCapacity 

func (s *Cluster) SetShardCapacity(v int64) *Cluster

SetShardCapacity sets the ShardCapacity field's value.

func (*Cluster) SetShardCount 

func (s *Cluster) SetShardCount(v int64) *Cluster

SetShardCount sets the ShardCount field's value.

func (*Cluster) SetShardInstanceCount added in v1.50.29 

func (s *Cluster) SetShardInstanceCount(v int64) *Cluster

SetShardInstanceCount sets the ShardInstanceCount field's value.

func (*Cluster) SetShards added in v1.50.29 

func (s *Cluster) SetShards(v []*Shard) *Cluster

SetShards sets the Shards field's value.

func (*Cluster) SetStatus 

func (s *Cluster) SetStatus(v string) *Cluster

SetStatus sets the Status field's value.

func (*Cluster) SetSubnetIds 

func (s *Cluster) SetSubnetIds(v []*string) *Cluster

SetSubnetIds sets the SubnetIds field's value.

func (*Cluster) SetVpcSecurityGroupIds 

func (s *Cluster) SetVpcSecurityGroupIds(v []*string) *Cluster

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (Cluster) String 

func (s Cluster) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClusterInList 

type ClusterInList struct {

	// The ARN identifier of the elastic cluster.
	//
	// ClusterArn is a required field
	ClusterArn *string `locationName:"clusterArn" type:"string" required:"true"`

	// The name of the elastic cluster.
	//
	// ClusterName is a required field
	ClusterName *string `locationName:"clusterName" type:"string" required:"true"`

	// The status of the elastic cluster.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"Status"`
	// contains filtered or unexported fields
}

A list of Amazon DocumentDB elastic clusters.

func (ClusterInList) GoString 

func (s ClusterInList) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterInList) SetClusterArn 

func (s *ClusterInList) SetClusterArn(v string) *ClusterInList

SetClusterArn sets the ClusterArn field's value.

func (*ClusterInList) SetClusterName 

func (s *ClusterInList) SetClusterName(v string) *ClusterInList

SetClusterName sets the ClusterName field's value.

func (*ClusterInList) SetStatus 

func (s *ClusterInList) SetStatus(v string) *ClusterInList

SetStatus sets the Status field's value.

func (ClusterInList) String 

func (s ClusterInList) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClusterSnapshot 

type ClusterSnapshot struct {

	// The name of the elastic cluster administrator.
	//
	// AdminUserName is a required field
	AdminUserName *string `locationName:"adminUserName" type:"string" required:"true"`

	// The ARN identifier of the elastic cluster.
	//
	// ClusterArn is a required field
	ClusterArn *string `locationName:"clusterArn" type:"string" required:"true"`

	// The time when the elastic cluster was created in Universal Coordinated Time
	// (UTC).
	//
	// ClusterCreationTime is a required field
	ClusterCreationTime *string `locationName:"clusterCreationTime" type:"string" required:"true"`

	// The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption
	// key. If you are creating a cluster using the same Amazon account that owns
	// this KMS encryption key, you can use the KMS key alias instead of the ARN
	// as the KMS encryption key. If an encryption key is not specified here, Amazon
	// DocumentDB uses the default encryption key that KMS creates for your account.
	// Your account has a different default encryption key for each Amazon Region.
	//
	// KmsKeyId is a required field
	KmsKeyId *string `locationName:"kmsKeyId" type:"string" required:"true"`

	// The ARN identifier of the elastic cluster snapshot.
	//
	// SnapshotArn is a required field
	SnapshotArn *string `locationName:"snapshotArn" type:"string" required:"true"`

	// The time when the elastic cluster snapshot was created in Universal Coordinated
	// Time (UTC).
	//
	// SnapshotCreationTime is a required field
	SnapshotCreationTime *string `locationName:"snapshotCreationTime" type:"string" required:"true"`

	// The name of the elastic cluster snapshot.
	//
	// SnapshotName is a required field
	SnapshotName *string `locationName:"snapshotName" type:"string" required:"true"`

	// The type of cluster snapshots to be returned. You can specify one of the
	// following values:
	//
	//    * automated - Return all cluster snapshots that Amazon DocumentDB has
	//    automatically created for your Amazon Web Services account.
	//
	//    * manual - Return all cluster snapshots that you have manually created
	//    for your Amazon Web Services account.
	SnapshotType *string `locationName:"snapshotType" type:"string" enum:"SnapshotType"`

	// The status of the elastic cluster snapshot.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"Status"`

	// The Amazon EC2 subnet IDs for the elastic cluster.
	//
	// SubnetIds is a required field
	SubnetIds []*string `locationName:"subnetIds" type:"list" required:"true"`

	// A list of EC2 VPC security groups to associate with the elastic cluster.
	//
	// VpcSecurityGroupIds is a required field
	VpcSecurityGroupIds []*string `locationName:"vpcSecurityGroupIds" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Returns information about a specific elastic cluster snapshot.

func (ClusterSnapshot) GoString 

func (s ClusterSnapshot) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterSnapshot) SetAdminUserName 

func (s *ClusterSnapshot) SetAdminUserName(v string) *ClusterSnapshot

SetAdminUserName sets the AdminUserName field's value.

func (*ClusterSnapshot) SetClusterArn 

func (s *ClusterSnapshot) SetClusterArn(v string) *ClusterSnapshot

SetClusterArn sets the ClusterArn field's value.

func (*ClusterSnapshot) SetClusterCreationTime 

func (s *ClusterSnapshot) SetClusterCreationTime(v string) *ClusterSnapshot

SetClusterCreationTime sets the ClusterCreationTime field's value.

func (*ClusterSnapshot) SetKmsKeyId 

func (s *ClusterSnapshot) SetKmsKeyId(v string) *ClusterSnapshot

SetKmsKeyId sets the KmsKeyId field's value.

func (*ClusterSnapshot) SetSnapshotArn 

func (s *ClusterSnapshot) SetSnapshotArn(v string) *ClusterSnapshot

SetSnapshotArn sets the SnapshotArn field's value.

func (*ClusterSnapshot) SetSnapshotCreationTime 

func (s *ClusterSnapshot) SetSnapshotCreationTime(v string) *ClusterSnapshot

SetSnapshotCreationTime sets the SnapshotCreationTime field's value.

func (*ClusterSnapshot) SetSnapshotName 

func (s *ClusterSnapshot) SetSnapshotName(v string) *ClusterSnapshot

SetSnapshotName sets the SnapshotName field's value.

func (*ClusterSnapshot) SetSnapshotType added in v1.50.29 

func (s *ClusterSnapshot) SetSnapshotType(v string) *ClusterSnapshot

SetSnapshotType sets the SnapshotType field's value.

func (*ClusterSnapshot) SetStatus 

func (s *ClusterSnapshot) SetStatus(v string) *ClusterSnapshot

SetStatus sets the Status field's value.

func (*ClusterSnapshot) SetSubnetIds 

func (s *ClusterSnapshot) SetSubnetIds(v []*string) *ClusterSnapshot

SetSubnetIds sets the SubnetIds field's value.

func (*ClusterSnapshot) SetVpcSecurityGroupIds 

func (s *ClusterSnapshot) SetVpcSecurityGroupIds(v []*string) *ClusterSnapshot

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (ClusterSnapshot) String 

func (s ClusterSnapshot) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ClusterSnapshotInList 

type ClusterSnapshotInList struct {

	// The ARN identifier of the elastic cluster.
	//
	// ClusterArn is a required field
	ClusterArn *string `locationName:"clusterArn" type:"string" required:"true"`

	// The ARN identifier of the elastic cluster snapshot.
	//
	// SnapshotArn is a required field
	SnapshotArn *string `locationName:"snapshotArn" type:"string" required:"true"`

	// The time when the elastic cluster snapshot was created in Universal Coordinated
	// Time (UTC).
	//
	// SnapshotCreationTime is a required field
	SnapshotCreationTime *string `locationName:"snapshotCreationTime" type:"string" required:"true"`

	// The name of the elastic cluster snapshot.
	//
	// SnapshotName is a required field
	SnapshotName *string `locationName:"snapshotName" type:"string" required:"true"`

	// The status of the elastic cluster snapshot.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"Status"`
	// contains filtered or unexported fields
}

A list of elastic cluster snapshots.

func (ClusterSnapshotInList) GoString 

func (s ClusterSnapshotInList) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ClusterSnapshotInList) SetClusterArn 

func (s *ClusterSnapshotInList) SetClusterArn(v string) *ClusterSnapshotInList

SetClusterArn sets the ClusterArn field's value.

func (*ClusterSnapshotInList) SetSnapshotArn 

func (s *ClusterSnapshotInList) SetSnapshotArn(v string) *ClusterSnapshotInList

SetSnapshotArn sets the SnapshotArn field's value.

func (*ClusterSnapshotInList) SetSnapshotCreationTime 

func (s *ClusterSnapshotInList) SetSnapshotCreationTime(v string) *ClusterSnapshotInList

SetSnapshotCreationTime sets the SnapshotCreationTime field's value.

func (*ClusterSnapshotInList) SetSnapshotName 

func (s *ClusterSnapshotInList) SetSnapshotName(v string) *ClusterSnapshotInList

SetSnapshotName sets the SnapshotName field's value.

func (*ClusterSnapshotInList) SetStatus 

func (s *ClusterSnapshotInList) SetStatus(v string) *ClusterSnapshotInList

SetStatus sets the Status field's value.

func (ClusterSnapshotInList) String 

func (s ClusterSnapshotInList) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The ID of the resource where there was an access conflict.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// The type of the resource where there was an access conflict.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
	// contains filtered or unexported fields
}

There was an access conflict.

func (*ConflictException) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CopyClusterSnapshotInput added in v1.50.29 

type CopyClusterSnapshotInput struct {

	// Set to true to copy all tags from the source cluster snapshot to the target
	// elastic cluster snapshot. The default is false.
	CopyTags *bool `locationName:"copyTags" type:"boolean"`

	// The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot.
	// The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon
	// Web Services KMS key identifier, or the Amazon Web Services KMS key alias
	// for the Amazon Web Services KMS encryption key.
	//
	// If you copy an encrypted elastic cluster snapshot from your Amazon Web Services
	// account, you can specify a value for KmsKeyId to encrypt the copy with a
	// new Amazon Web ServicesS KMS encryption key. If you don't specify a value
	// for KmsKeyId, then the copy of the elastic cluster snapshot is encrypted
	// with the same AWS KMS key as the source elastic cluster snapshot.
	//
	// To copy an encrypted elastic cluster snapshot to another Amazon Web Services
	// region, set KmsKeyId to the Amazon Web Services KMS key ID that you want
	// to use to encrypt the copy of the elastic cluster snapshot in the destination
	// region. Amazon Web Services KMS encryption keys are specific to the Amazon
	// Web Services region that they are created in, and you can't use encryption
	// keys from one Amazon Web Services region in another Amazon Web Services region.
	//
	// If you copy an unencrypted elastic cluster snapshot and specify a value for
	// the KmsKeyId parameter, an error is returned.
	KmsKeyId *string `locationName:"kmsKeyId" type:"string"`

	// The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.
	//
	// SnapshotArn is a required field
	SnapshotArn *string `location:"uri" locationName:"snapshotArn" type:"string" required:"true"`

	// The tags to be assigned to the elastic cluster snapshot.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The identifier of the new elastic cluster snapshot to create from the source
	// cluster snapshot. This parameter is not case sensitive.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens.
	//
	//    * The first character must be a letter.
	//
	//    * Cannot end with a hyphen or contain two consecutive hyphens.
	//
	// Example: elastic-cluster-snapshot-5
	//
	// TargetSnapshotName is a required field
	TargetSnapshotName *string `locationName:"targetSnapshotName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CopyClusterSnapshotInput) GoString added in v1.50.29 

func (s CopyClusterSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyClusterSnapshotInput) SetCopyTags added in v1.50.29 

func (s *CopyClusterSnapshotInput) SetCopyTags(v bool) *CopyClusterSnapshotInput

SetCopyTags sets the CopyTags field's value.

func (*CopyClusterSnapshotInput) SetKmsKeyId added in v1.50.29 

func (s *CopyClusterSnapshotInput) SetKmsKeyId(v string) *CopyClusterSnapshotInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CopyClusterSnapshotInput) SetSnapshotArn added in v1.50.29 

func (s *CopyClusterSnapshotInput) SetSnapshotArn(v string) *CopyClusterSnapshotInput

SetSnapshotArn sets the SnapshotArn field's value.

func (*CopyClusterSnapshotInput) SetTags added in v1.50.29 

func (s *CopyClusterSnapshotInput) SetTags(v map[string]*string) *CopyClusterSnapshotInput

SetTags sets the Tags field's value.

func (*CopyClusterSnapshotInput) SetTargetSnapshotName added in v1.50.29 

func (s *CopyClusterSnapshotInput) SetTargetSnapshotName(v string) *CopyClusterSnapshotInput

SetTargetSnapshotName sets the TargetSnapshotName field's value.

func (CopyClusterSnapshotInput) String added in v1.50.29 

func (s CopyClusterSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyClusterSnapshotInput) Validate added in v1.50.29 

func (s *CopyClusterSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CopyClusterSnapshotOutput added in v1.50.29 

type CopyClusterSnapshotOutput struct {

	// Returns information about a specific elastic cluster snapshot.
	//
	// Snapshot is a required field
	Snapshot *ClusterSnapshot `locationName:"snapshot" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CopyClusterSnapshotOutput) GoString added in v1.50.29 

func (s CopyClusterSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CopyClusterSnapshotOutput) SetSnapshot added in v1.50.29 

func (s *CopyClusterSnapshotOutput) SetSnapshot(v *ClusterSnapshot) *CopyClusterSnapshotOutput

SetSnapshot sets the Snapshot field's value.

func (CopyClusterSnapshotOutput) String added in v1.50.29 

func (s CopyClusterSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateClusterInput 

type CreateClusterInput struct {

	// The name of the Amazon DocumentDB elastic clusters administrator.
	//
	// Constraints:
	//
	//    * Must be from 1 to 63 letters or numbers.
	//
	//    * The first character must be a letter.
	//
	//    * Cannot be a reserved word.
	//
	// AdminUserName is a required field
	AdminUserName *string `locationName:"adminUserName" type:"string" required:"true"`

	// The password for the Amazon DocumentDB elastic clusters administrator. The
	// password can contain any printable ASCII characters.
	//
	// Constraints:
	//
	//    * Must contain from 8 to 100 characters.
	//
	//    * Cannot contain a forward slash (/), double quote ("), or the "at" symbol
	//    (@).
	//
	// AdminUserPassword is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateClusterInput's
	// String and GoString methods.
	//
	// AdminUserPassword is a required field
	AdminUserPassword *string `locationName:"adminUserPassword" type:"string" required:"true" sensitive:"true"`

	// The authentication type used to determine where to fetch the password used
	// for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.
	//
	// AuthType is a required field
	AuthType *string `locationName:"authType" type:"string" required:"true" enum:"Auth"`

	// The number of days for which automatic snapshots are retained.
	BackupRetentionPeriod *int64 `locationName:"backupRetentionPeriod" type:"integer"`

	// The client token for the elastic cluster.
	ClientToken *string `locationName:"clientToken" type:"string" idempotencyToken:"true"`

	// The name of the new elastic cluster. This parameter is stored as a lowercase
	// string.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens.
	//
	//    * The first character must be a letter.
	//
	//    * Cannot end with a hyphen or contain two consecutive hyphens.
	//
	// Example: my-cluster
	//
	// ClusterName is a required field
	ClusterName *string `locationName:"clusterName" type:"string" required:"true"`

	// The KMS key identifier to use to encrypt the new elastic cluster.
	//
	// The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption
	// key. If you are creating a cluster using the same Amazon account that owns
	// this KMS encryption key, you can use the KMS key alias instead of the ARN
	// as the KMS encryption key.
	//
	// If an encryption key is not specified, Amazon DocumentDB uses the default
	// encryption key that KMS creates for your account. Your account has a different
	// default encryption key for each Amazon Region.
	KmsKeyId *string `locationName:"kmsKeyId" type:"string"`

	// The daily time range during which automated backups are created if automated
	// backups are enabled, as determined by the backupRetentionPeriod.
	PreferredBackupWindow *string `locationName:"preferredBackupWindow" type:"string"`

	// The weekly time range during which system maintenance can occur, in Universal
	// Coordinated Time (UTC).
	//
	// Format: ddd:hh24:mi-ddd:hh24:mi
	//
	// Default: a 30-minute window selected at random from an 8-hour block of time
	// for each Amazon Web Services Region, occurring on a random day of the week.
	//
	// Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
	//
	// Constraints: Minimum 30-minute window.
	PreferredMaintenanceWindow *string `locationName:"preferredMaintenanceWindow" type:"string"`

	// The number of vCPUs assigned to each elastic cluster shard. Maximum is 64.
	// Allowed values are 2, 4, 8, 16, 32, 64.
	//
	// ShardCapacity is a required field
	ShardCapacity *int64 `locationName:"shardCapacity" type:"integer" required:"true"`

	// The number of shards assigned to the elastic cluster. Maximum is 32.
	//
	// ShardCount is a required field
	ShardCount *int64 `locationName:"shardCount" type:"integer" required:"true"`

	// The number of replica instances applying to all shards in the elastic cluster.
	// A shardInstanceCount value of 1 means there is one writer instance, and any
	// additional instances are replicas that can be used for reads and to improve
	// availability.
	ShardInstanceCount *int64 `locationName:"shardInstanceCount" type:"integer"`

	// The Amazon EC2 subnet IDs for the new elastic cluster.
	SubnetIds []*string `locationName:"subnetIds" type:"list"`

	// The tags to be assigned to the new elastic cluster.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// A list of EC2 VPC security groups to associate with the new elastic cluster.
	VpcSecurityGroupIds []*string `locationName:"vpcSecurityGroupIds" type:"list"`
	// contains filtered or unexported fields
}

func (CreateClusterInput) GoString 

func (s CreateClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateClusterInput) SetAdminUserName 

func (s *CreateClusterInput) SetAdminUserName(v string) *CreateClusterInput

SetAdminUserName sets the AdminUserName field's value.

func (*CreateClusterInput) SetAdminUserPassword 

func (s *CreateClusterInput) SetAdminUserPassword(v string) *CreateClusterInput

SetAdminUserPassword sets the AdminUserPassword field's value.

func (*CreateClusterInput) SetAuthType 

func (s *CreateClusterInput) SetAuthType(v string) *CreateClusterInput

SetAuthType sets the AuthType field's value.

func (*CreateClusterInput) SetBackupRetentionPeriod added in v1.50.29 

func (s *CreateClusterInput) SetBackupRetentionPeriod(v int64) *CreateClusterInput

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*CreateClusterInput) SetClientToken 

func (s *CreateClusterInput) SetClientToken(v string) *CreateClusterInput

SetClientToken sets the ClientToken field's value.

func (*CreateClusterInput) SetClusterName 

func (s *CreateClusterInput) SetClusterName(v string) *CreateClusterInput

SetClusterName sets the ClusterName field's value.

func (*CreateClusterInput) SetKmsKeyId 

func (s *CreateClusterInput) SetKmsKeyId(v string) *CreateClusterInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateClusterInput) SetPreferredBackupWindow added in v1.50.29 

func (s *CreateClusterInput) SetPreferredBackupWindow(v string) *CreateClusterInput

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*CreateClusterInput) SetPreferredMaintenanceWindow 

func (s *CreateClusterInput) SetPreferredMaintenanceWindow(v string) *CreateClusterInput

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*CreateClusterInput) SetShardCapacity 

func (s *CreateClusterInput) SetShardCapacity(v int64) *CreateClusterInput

SetShardCapacity sets the ShardCapacity field's value.

func (*CreateClusterInput) SetShardCount 

func (s *CreateClusterInput) SetShardCount(v int64) *CreateClusterInput

SetShardCount sets the ShardCount field's value.

func (*CreateClusterInput) SetShardInstanceCount added in v1.50.29 

func (s *CreateClusterInput) SetShardInstanceCount(v int64) *CreateClusterInput

SetShardInstanceCount sets the ShardInstanceCount field's value.

func (*CreateClusterInput) SetSubnetIds 

func (s *CreateClusterInput) SetSubnetIds(v []*string) *CreateClusterInput

SetSubnetIds sets the SubnetIds field's value.

func (*CreateClusterInput) SetTags 

func (s *CreateClusterInput) SetTags(v map[string]*string) *CreateClusterInput

SetTags sets the Tags field's value.

func (*CreateClusterInput) SetVpcSecurityGroupIds 

func (s *CreateClusterInput) SetVpcSecurityGroupIds(v []*string) *CreateClusterInput

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (CreateClusterInput) String 

func (s CreateClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateClusterInput) Validate 

func (s *CreateClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateClusterOutput 

type CreateClusterOutput struct {

	// The new elastic cluster that has been created.
	//
	// Cluster is a required field
	Cluster *Cluster `locationName:"cluster" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateClusterOutput) GoString 

func (s CreateClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateClusterOutput) SetCluster 

func (s *CreateClusterOutput) SetCluster(v *Cluster) *CreateClusterOutput

SetCluster sets the Cluster field's value.

func (CreateClusterOutput) String 

func (s CreateClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateClusterSnapshotInput 

type CreateClusterSnapshotInput struct {

	// The ARN identifier of the elastic cluster of which you want to create a snapshot.
	//
	// ClusterArn is a required field
	ClusterArn *string `locationName:"clusterArn" type:"string" required:"true"`

	// The name of the new elastic cluster snapshot.
	//
	// SnapshotName is a required field
	SnapshotName *string `locationName:"snapshotName" min:"1" type:"string" required:"true"`

	// The tags to be assigned to the new elastic cluster snapshot.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (CreateClusterSnapshotInput) GoString 

func (s CreateClusterSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateClusterSnapshotInput) SetClusterArn 

func (s *CreateClusterSnapshotInput) SetClusterArn(v string) *CreateClusterSnapshotInput

SetClusterArn sets the ClusterArn field's value.

func (*CreateClusterSnapshotInput) SetSnapshotName 

func (s *CreateClusterSnapshotInput) SetSnapshotName(v string) *CreateClusterSnapshotInput

SetSnapshotName sets the SnapshotName field's value.

func (*CreateClusterSnapshotInput) SetTags 

func (s *CreateClusterSnapshotInput) SetTags(v map[string]*string) *CreateClusterSnapshotInput

SetTags sets the Tags field's value.

func (CreateClusterSnapshotInput) String 

func (s CreateClusterSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateClusterSnapshotInput) Validate 

func (s *CreateClusterSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateClusterSnapshotOutput 

type CreateClusterSnapshotOutput struct {

	// Returns information about the new elastic cluster snapshot.
	//
	// Snapshot is a required field
	Snapshot *ClusterSnapshot `locationName:"snapshot" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateClusterSnapshotOutput) GoString 

func (s CreateClusterSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateClusterSnapshotOutput) SetSnapshot 

func (s *CreateClusterSnapshotOutput) SetSnapshot(v *ClusterSnapshot) *CreateClusterSnapshotOutput

SetSnapshot sets the Snapshot field's value.

func (CreateClusterSnapshotOutput) String 

func (s CreateClusterSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteClusterInput 

type DeleteClusterInput struct {

	// The ARN identifier of the elastic cluster that is to be deleted.
	//
	// ClusterArn is a required field
	ClusterArn *string `location:"uri" locationName:"clusterArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteClusterInput) GoString 

func (s DeleteClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteClusterInput) SetClusterArn 

func (s *DeleteClusterInput) SetClusterArn(v string) *DeleteClusterInput

SetClusterArn sets the ClusterArn field's value.

func (DeleteClusterInput) String 

func (s DeleteClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteClusterInput) Validate 

func (s *DeleteClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteClusterOutput 

type DeleteClusterOutput struct {

	// Returns information about the newly deleted elastic cluster.
	//
	// Cluster is a required field
	Cluster *Cluster `locationName:"cluster" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteClusterOutput) GoString 

func (s DeleteClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteClusterOutput) SetCluster 

func (s *DeleteClusterOutput) SetCluster(v *Cluster) *DeleteClusterOutput

SetCluster sets the Cluster field's value.

func (DeleteClusterOutput) String 

func (s DeleteClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteClusterSnapshotInput 

type DeleteClusterSnapshotInput struct {

	// The ARN identifier of the elastic cluster snapshot that is to be deleted.
	//
	// SnapshotArn is a required field
	SnapshotArn *string `location:"uri" locationName:"snapshotArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteClusterSnapshotInput) GoString 

func (s DeleteClusterSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteClusterSnapshotInput) SetSnapshotArn 

func (s *DeleteClusterSnapshotInput) SetSnapshotArn(v string) *DeleteClusterSnapshotInput

SetSnapshotArn sets the SnapshotArn field's value.

func (DeleteClusterSnapshotInput) String 

func (s DeleteClusterSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteClusterSnapshotInput) Validate 

func (s *DeleteClusterSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteClusterSnapshotOutput 

type DeleteClusterSnapshotOutput struct {

	// Returns information about the newly deleted elastic cluster snapshot.
	//
	// Snapshot is a required field
	Snapshot *ClusterSnapshot `locationName:"snapshot" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteClusterSnapshotOutput) GoString 

func (s DeleteClusterSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteClusterSnapshotOutput) SetSnapshot 

func (s *DeleteClusterSnapshotOutput) SetSnapshot(v *ClusterSnapshot) *DeleteClusterSnapshotOutput

SetSnapshot sets the Snapshot field's value.

func (DeleteClusterSnapshotOutput) String 

func (s DeleteClusterSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DocDBElastic 

type DocDBElastic struct {
	*client.Client
}

DocDBElastic provides the API operation methods for making requests to Amazon DocumentDB Elastic Clusters. See this package's package overview docs for details on the service.

DocDBElastic methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *DocDBElastic

New creates a new instance of the DocDBElastic client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a DocDBElastic client from just a session.
svc := docdbelastic.New(mySession)

// Create a DocDBElastic client with additional configuration
svc := docdbelastic.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*DocDBElastic) CopyClusterSnapshot added in v1.50.29 

func (c *DocDBElastic) CopyClusterSnapshot(input *CopyClusterSnapshotInput) (*CopyClusterSnapshotOutput, error)

CopyClusterSnapshot API operation for Amazon DocumentDB Elastic Clusters.

Copies a snapshot of an elastic cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DocumentDB Elastic Clusters's API operation CopyClusterSnapshot for usage and error information.

Returned Error Types:

  • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.

  • ValidationException A structure defining a validation exception.

  • ServiceQuotaExceededException The service quota for the action was exceeded.

  • ConflictException There was an access conflict.

  • InternalServerException There was an internal server error.

  • ResourceNotFoundException The specified resource could not be located.

  • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CopyClusterSnapshot

func (*DocDBElastic) CopyClusterSnapshotRequest added in v1.50.29 

func (c *DocDBElastic) CopyClusterSnapshotRequest(input *CopyClusterSnapshotInput) (req *request.Request, output *CopyClusterSnapshotOutput)

CopyClusterSnapshotRequest generates a "aws/request.Request" representing the client's request for the CopyClusterSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CopyClusterSnapshot for more information on using the CopyClusterSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CopyClusterSnapshotRequest method.
req, resp := client.CopyClusterSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CopyClusterSnapshot

func (*DocDBElastic) CopyClusterSnapshotWithContext added in v1.50.29 

func (c *DocDBElastic) CopyClusterSnapshotWithContext(ctx aws.Context, input *CopyClusterSnapshotInput, opts ...request.Option) (*CopyClusterSnapshotOutput, error)

CopyClusterSnapshotWithContext is the same as CopyClusterSnapshot with the addition of the ability to pass a context and additional request options.

See CopyClusterSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DocDBElastic) CreateCluster 

func (c *DocDBElastic) CreateCluster(input *CreateClusterInput) (*CreateClusterOutput, error)

CreateCluster API operation for Amazon DocumentDB Elastic Clusters.

Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DocumentDB Elastic Clusters's API operation CreateCluster for usage and error information.

Returned Error Types:

  • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.

  • ValidationException A structure defining a validation exception.

  • ServiceQuotaExceededException The service quota for the action was exceeded.

  • ConflictException There was an access conflict.

  • InternalServerException There was an internal server error.

  • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CreateCluster

func (*DocDBElastic) CreateClusterRequest 

func (c *DocDBElastic) CreateClusterRequest(input *CreateClusterInput) (req *request.Request, output *CreateClusterOutput)

CreateClusterRequest generates a "aws/request.Request" representing the client's request for the CreateCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCluster for more information on using the CreateCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateClusterRequest method.
req, resp := client.CreateClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CreateCluster

func (*DocDBElastic) CreateClusterSnapshot 

func (c *DocDBElastic) CreateClusterSnapshot(input *CreateClusterSnapshotInput) (*CreateClusterSnapshotOutput, error)

CreateClusterSnapshot API operation for Amazon DocumentDB Elastic Clusters.

Creates a snapshot of an elastic cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DocumentDB Elastic Clusters's API operation CreateClusterSnapshot for usage and error information.

Returned Error Types:

  • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.

  • ValidationException A structure defining a validation exception.

  • ServiceQuotaExceededException The service quota for the action was exceeded.

  • ConflictException There was an access conflict.

  • InternalServerException There was an internal server error.

  • ResourceNotFoundException The specified resource could not be located.

  • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CreateClusterSnapshot

func (*DocDBElastic) CreateClusterSnapshotRequest 

func (c *DocDBElastic) CreateClusterSnapshotRequest(input *CreateClusterSnapshotInput) (req *request.Request, output *CreateClusterSnapshotOutput)

CreateClusterSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateClusterSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateClusterSnapshot for more information on using the CreateClusterSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateClusterSnapshotRequest method.
req, resp := client.CreateClusterSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/CreateClusterSnapshot

func (*DocDBElastic) CreateClusterSnapshotWithContext 

func (c *DocDBElastic) CreateClusterSnapshotWithContext(ctx aws.Context, input *CreateClusterSnapshotInput, opts ...request.Option) (*CreateClusterSnapshotOutput, error)

CreateClusterSnapshotWithContext is the same as CreateClusterSnapshot with the addition of the ability to pass a context and additional request options.

See CreateClusterSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DocDBElastic) CreateClusterWithContext 

func (c *DocDBElastic) CreateClusterWithContext(ctx aws.Context, input *CreateClusterInput, opts ...request.Option) (*CreateClusterOutput, error)

CreateClusterWithContext is the same as CreateCluster with the addition of the ability to pass a context and additional request options.

See CreateCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DocDBElastic) DeleteCluster 

func (c *DocDBElastic) DeleteCluster(input *DeleteClusterInput) (*DeleteClusterOutput, error)

DeleteCluster API operation for Amazon DocumentDB Elastic Clusters.

Delete an elastic cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DocumentDB Elastic Clusters's API operation DeleteCluster for usage and error information.

Returned Error Types:

  • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.

  • ValidationException A structure defining a validation exception.

  • ConflictException There was an access conflict.

  • InternalServerException There was an internal server error.

  • ResourceNotFoundException The specified resource could not be located.

  • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/DeleteCluster

func (*DocDBElastic) DeleteClusterRequest 

func (c *DocDBElastic) DeleteClusterRequest(input *DeleteClusterInput) (req *request.Request, output *DeleteClusterOutput)

DeleteClusterRequest generates a "aws/request.Request" representing the client's request for the DeleteCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCluster for more information on using the DeleteCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteClusterRequest method.
req, resp := client.DeleteClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/DeleteCluster

func (*DocDBElastic) DeleteClusterSnapshot 

func (c *DocDBElastic) DeleteClusterSnapshot(input *DeleteClusterSnapshotInput) (*DeleteClusterSnapshotOutput, error)

DeleteClusterSnapshot API operation for Amazon DocumentDB Elastic Clusters.

Delete an elastic cluster snapshot.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DocumentDB Elastic Clusters's API operation DeleteClusterSnapshot for usage and error information.

Returned Error Types:

  • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.

  • ValidationException A structure defining a validation exception.

  • ConflictException There was an access conflict.

  • InternalServerException There was an internal server error.

  • ResourceNotFoundException The specified resource could not be located.

  • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/DeleteClusterSnapshot

func (*DocDBElastic) DeleteClusterSnapshotRequest 

func (c *DocDBElastic) DeleteClusterSnapshotRequest(input *DeleteClusterSnapshotInput) (req *request.Request, output *DeleteClusterSnapshotOutput)

DeleteClusterSnapshotRequest generates a "aws/request.Request" representing the client's request for the DeleteClusterSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteClusterSnapshot for more information on using the DeleteClusterSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteClusterSnapshotRequest method.
req, resp := client.DeleteClusterSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/DeleteClusterSnapshot

func (*DocDBElastic) DeleteClusterSnapshotWithContext 

func (c *DocDBElastic) DeleteClusterSnapshotWithContext(ctx aws.Context, input *DeleteClusterSnapshotInput, opts ...request.Option) (*DeleteClusterSnapshotOutput, error)

DeleteClusterSnapshotWithContext is the same as DeleteClusterSnapshot with the addition of the ability to pass a context and additional request options.

See DeleteClusterSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DocDBElastic) DeleteClusterWithContext 

func (c *DocDBElastic) DeleteClusterWithContext(ctx aws.Context, input *DeleteClusterInput, opts ...request.Option) (*DeleteClusterOutput, error)

DeleteClusterWithContext is the same as DeleteCluster with the addition of the ability to pass a context and additional request options.

See DeleteCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DocDBElastic) GetCluster 

func (c *DocDBElastic) GetCluster(input *GetClusterInput) (*GetClusterOutput, error)

GetCluster API operation for Amazon DocumentDB Elastic Clusters.

Returns information about a specific elastic cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DocumentDB Elastic Clusters's API operation GetCluster for usage and error information.

Returned Error Types:

  • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.

  • ValidationException A structure defining a validation exception.

  • InternalServerException There was an internal server error.

  • ResourceNotFoundException The specified resource could not be located.

  • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/GetCluster

func (*DocDBElastic) GetClusterRequest 

func (c *DocDBElastic) GetClusterRequest(input *GetClusterInput) (req *request.Request, output *GetClusterOutput)

GetClusterRequest generates a "aws/request.Request" representing the client's request for the GetCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetCluster for more information on using the GetCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetClusterRequest method.
req, resp := client.GetClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/GetCluster

func (*DocDBElastic) GetClusterSnapshot 

func (c *DocDBElastic) GetClusterSnapshot(input *GetClusterSnapshotInput) (*GetClusterSnapshotOutput, error)

GetClusterSnapshot API operation for Amazon DocumentDB Elastic Clusters.

Returns information about a specific elastic cluster snapshot

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DocumentDB Elastic Clusters's API operation GetClusterSnapshot for usage and error information.

Returned Error Types:

  • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.

  • ValidationException A structure defining a validation exception.

  • InternalServerException There was an internal server error.

  • ResourceNotFoundException The specified resource could not be located.

  • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/GetClusterSnapshot

func (*DocDBElastic) GetClusterSnapshotRequest 

func (c *DocDBElastic) GetClusterSnapshotRequest(input *GetClusterSnapshotInput) (req *request.Request, output *GetClusterSnapshotOutput)

GetClusterSnapshotRequest generates a "aws/request.Request" representing the client's request for the GetClusterSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetClusterSnapshot for more information on using the GetClusterSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetClusterSnapshotRequest method.
req, resp := client.GetClusterSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/GetClusterSnapshot

func (*DocDBElastic) GetClusterSnapshotWithContext 

func (c *DocDBElastic) GetClusterSnapshotWithContext(ctx aws.Context, input *GetClusterSnapshotInput, opts ...request.Option) (*GetClusterSnapshotOutput, error)

GetClusterSnapshotWithContext is the same as GetClusterSnapshot with the addition of the ability to pass a context and additional request options.

See GetClusterSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DocDBElastic) GetClusterWithContext 

func (c *DocDBElastic) GetClusterWithContext(ctx aws.Context, input *GetClusterInput, opts ...request.Option) (*GetClusterOutput, error)

GetClusterWithContext is the same as GetCluster with the addition of the ability to pass a context and additional request options.

See GetCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DocDBElastic) ListClusterSnapshots 

func (c *DocDBElastic) ListClusterSnapshots(input *ListClusterSnapshotsInput) (*ListClusterSnapshotsOutput, error)

ListClusterSnapshots API operation for Amazon DocumentDB Elastic Clusters.

Returns information about snapshots for a specified elastic cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DocumentDB Elastic Clusters's API operation ListClusterSnapshots for usage and error information.

Returned Error Types:

  • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.

  • ValidationException A structure defining a validation exception.

  • InternalServerException There was an internal server error.

  • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListClusterSnapshots

func (*DocDBElastic) ListClusterSnapshotsPages 

func (c *DocDBElastic) ListClusterSnapshotsPages(input *ListClusterSnapshotsInput, fn func(*ListClusterSnapshotsOutput, bool) bool) error

ListClusterSnapshotsPages iterates over the pages of a ListClusterSnapshots operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListClusterSnapshots method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListClusterSnapshots operation.
pageNum := 0
err := client.ListClusterSnapshotsPages(params,
    func(page *docdbelastic.ListClusterSnapshotsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DocDBElastic) ListClusterSnapshotsPagesWithContext 

func (c *DocDBElastic) ListClusterSnapshotsPagesWithContext(ctx aws.Context, input *ListClusterSnapshotsInput, fn func(*ListClusterSnapshotsOutput, bool) bool, opts ...request.Option) error

ListClusterSnapshotsPagesWithContext same as ListClusterSnapshotsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DocDBElastic) ListClusterSnapshotsRequest 

func (c *DocDBElastic) ListClusterSnapshotsRequest(input *ListClusterSnapshotsInput) (req *request.Request, output *ListClusterSnapshotsOutput)

ListClusterSnapshotsRequest generates a "aws/request.Request" representing the client's request for the ListClusterSnapshots operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListClusterSnapshots for more information on using the ListClusterSnapshots API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListClusterSnapshotsRequest method.
req, resp := client.ListClusterSnapshotsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListClusterSnapshots

func (*DocDBElastic) ListClusterSnapshotsWithContext 

func (c *DocDBElastic) ListClusterSnapshotsWithContext(ctx aws.Context, input *ListClusterSnapshotsInput, opts ...request.Option) (*ListClusterSnapshotsOutput, error)

ListClusterSnapshotsWithContext is the same as ListClusterSnapshots with the addition of the ability to pass a context and additional request options.

See ListClusterSnapshots for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DocDBElastic) ListClusters 

func (c *DocDBElastic) ListClusters(input *ListClustersInput) (*ListClustersOutput, error)

ListClusters API operation for Amazon DocumentDB Elastic Clusters.

Returns information about provisioned Amazon DocumentDB elastic clusters.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DocumentDB Elastic Clusters's API operation ListClusters for usage and error information.

Returned Error Types:

  • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.

  • ValidationException A structure defining a validation exception.

  • InternalServerException There was an internal server error.

  • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListClusters

func (*DocDBElastic) ListClustersPages 

func (c *DocDBElastic) ListClustersPages(input *ListClustersInput, fn func(*ListClustersOutput, bool) bool) error

ListClustersPages iterates over the pages of a ListClusters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListClusters method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListClusters operation.
pageNum := 0
err := client.ListClustersPages(params,
    func(page *docdbelastic.ListClustersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DocDBElastic) ListClustersPagesWithContext 

func (c *DocDBElastic) ListClustersPagesWithContext(ctx aws.Context, input *ListClustersInput, fn func(*ListClustersOutput, bool) bool, opts ...request.Option) error

ListClustersPagesWithContext same as ListClustersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DocDBElastic) ListClustersRequest 

func (c *DocDBElastic) ListClustersRequest(input *ListClustersInput) (req *request.Request, output *ListClustersOutput)

ListClustersRequest generates a "aws/request.Request" representing the client's request for the ListClusters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListClusters for more information on using the ListClusters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListClustersRequest method.
req, resp := client.ListClustersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListClusters

func (*DocDBElastic) ListClustersWithContext 

func (c *DocDBElastic) ListClustersWithContext(ctx aws.Context, input *ListClustersInput, opts ...request.Option) (*ListClustersOutput, error)

ListClustersWithContext is the same as ListClusters with the addition of the ability to pass a context and additional request options.

See ListClusters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DocDBElastic) ListTagsForResource 

func (c *DocDBElastic) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon DocumentDB Elastic Clusters.

Lists all tags on a elastic cluster resource

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DocumentDB Elastic Clusters's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.

  • ValidationException A structure defining a validation exception.

  • InternalServerException There was an internal server error.

  • ResourceNotFoundException The specified resource could not be located.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListTagsForResource

func (*DocDBElastic) ListTagsForResourceRequest 

func (c *DocDBElastic) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/ListTagsForResource

func (*DocDBElastic) ListTagsForResourceWithContext 

func (c *DocDBElastic) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DocDBElastic) RestoreClusterFromSnapshot 

func (c *DocDBElastic) RestoreClusterFromSnapshot(input *RestoreClusterFromSnapshotInput) (*RestoreClusterFromSnapshotOutput, error)

RestoreClusterFromSnapshot API operation for Amazon DocumentDB Elastic Clusters.

Restores an elastic cluster from a snapshot.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DocumentDB Elastic Clusters's API operation RestoreClusterFromSnapshot for usage and error information.

Returned Error Types:

  • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.

  • ValidationException A structure defining a validation exception.

  • ServiceQuotaExceededException The service quota for the action was exceeded.

  • ConflictException There was an access conflict.

  • InternalServerException There was an internal server error.

  • ResourceNotFoundException The specified resource could not be located.

  • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot

func (*DocDBElastic) RestoreClusterFromSnapshotRequest 

func (c *DocDBElastic) RestoreClusterFromSnapshotRequest(input *RestoreClusterFromSnapshotInput) (req *request.Request, output *RestoreClusterFromSnapshotOutput)

RestoreClusterFromSnapshotRequest generates a "aws/request.Request" representing the client's request for the RestoreClusterFromSnapshot operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RestoreClusterFromSnapshot for more information on using the RestoreClusterFromSnapshot API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RestoreClusterFromSnapshotRequest method.
req, resp := client.RestoreClusterFromSnapshotRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/RestoreClusterFromSnapshot

func (*DocDBElastic) RestoreClusterFromSnapshotWithContext 

func (c *DocDBElastic) RestoreClusterFromSnapshotWithContext(ctx aws.Context, input *RestoreClusterFromSnapshotInput, opts ...request.Option) (*RestoreClusterFromSnapshotOutput, error)

RestoreClusterFromSnapshotWithContext is the same as RestoreClusterFromSnapshot with the addition of the ability to pass a context and additional request options.

See RestoreClusterFromSnapshot for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DocDBElastic) StartCluster added in v1.50.29 

func (c *DocDBElastic) StartCluster(input *StartClusterInput) (*StartClusterOutput, error)

StartCluster API operation for Amazon DocumentDB Elastic Clusters.

Restarts the stopped elastic cluster that is specified by clusterARN.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DocumentDB Elastic Clusters's API operation StartCluster for usage and error information.

Returned Error Types:

  • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.

  • ValidationException A structure defining a validation exception.

  • InternalServerException There was an internal server error.

  • ResourceNotFoundException The specified resource could not be located.

  • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/StartCluster

func (*DocDBElastic) StartClusterRequest added in v1.50.29 

func (c *DocDBElastic) StartClusterRequest(input *StartClusterInput) (req *request.Request, output *StartClusterOutput)

StartClusterRequest generates a "aws/request.Request" representing the client's request for the StartCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartCluster for more information on using the StartCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StartClusterRequest method.
req, resp := client.StartClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/StartCluster

func (*DocDBElastic) StartClusterWithContext added in v1.50.29 

func (c *DocDBElastic) StartClusterWithContext(ctx aws.Context, input *StartClusterInput, opts ...request.Option) (*StartClusterOutput, error)

StartClusterWithContext is the same as StartCluster with the addition of the ability to pass a context and additional request options.

See StartCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DocDBElastic) StopCluster added in v1.50.29 

func (c *DocDBElastic) StopCluster(input *StopClusterInput) (*StopClusterOutput, error)

StopCluster API operation for Amazon DocumentDB Elastic Clusters.

Stops the running elastic cluster that is specified by clusterArn. The elastic cluster must be in the available state.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DocumentDB Elastic Clusters's API operation StopCluster for usage and error information.

Returned Error Types:

  • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.

  • ValidationException A structure defining a validation exception.

  • InternalServerException There was an internal server error.

  • ResourceNotFoundException The specified resource could not be located.

  • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/StopCluster

func (*DocDBElastic) StopClusterRequest added in v1.50.29 

func (c *DocDBElastic) StopClusterRequest(input *StopClusterInput) (req *request.Request, output *StopClusterOutput)

StopClusterRequest generates a "aws/request.Request" representing the client's request for the StopCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopCluster for more information on using the StopCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the StopClusterRequest method.
req, resp := client.StopClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/StopCluster

func (*DocDBElastic) StopClusterWithContext added in v1.50.29 

func (c *DocDBElastic) StopClusterWithContext(ctx aws.Context, input *StopClusterInput, opts ...request.Option) (*StopClusterOutput, error)

StopClusterWithContext is the same as StopCluster with the addition of the ability to pass a context and additional request options.

See StopCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DocDBElastic) TagResource 

func (c *DocDBElastic) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon DocumentDB Elastic Clusters.

Adds metadata tags to an elastic cluster resource

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DocumentDB Elastic Clusters's API operation TagResource for usage and error information.

Returned Error Types:

  • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.

  • ValidationException A structure defining a validation exception.

  • InternalServerException There was an internal server error.

  • ResourceNotFoundException The specified resource could not be located.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/TagResource

func (*DocDBElastic) TagResourceRequest 

func (c *DocDBElastic) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/TagResource

func (*DocDBElastic) TagResourceWithContext 

func (c *DocDBElastic) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DocDBElastic) UntagResource 

func (c *DocDBElastic) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon DocumentDB Elastic Clusters.

Removes metadata tags from an elastic cluster resource

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DocumentDB Elastic Clusters's API operation UntagResource for usage and error information.

Returned Error Types:

  • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.

  • ValidationException A structure defining a validation exception.

  • InternalServerException There was an internal server error.

  • ResourceNotFoundException The specified resource could not be located.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/UntagResource

func (*DocDBElastic) UntagResourceRequest 

func (c *DocDBElastic) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/UntagResource

func (*DocDBElastic) UntagResourceWithContext 

func (c *DocDBElastic) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*DocDBElastic) UpdateCluster 

func (c *DocDBElastic) UpdateCluster(input *UpdateClusterInput) (*UpdateClusterOutput, error)

UpdateCluster API operation for Amazon DocumentDB Elastic Clusters.

Modifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and setting up a backup window and maintenance window

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon DocumentDB Elastic Clusters's API operation UpdateCluster for usage and error information.

Returned Error Types:

  • ThrottlingException ThrottlingException will be thrown when request was denied due to request throttling.

  • ValidationException A structure defining a validation exception.

  • ConflictException There was an access conflict.

  • InternalServerException There was an internal server error.

  • ResourceNotFoundException The specified resource could not be located.

  • AccessDeniedException An exception that occurs when there are not sufficient permissions to perform an action.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/UpdateCluster

func (*DocDBElastic) UpdateClusterRequest 

func (c *DocDBElastic) UpdateClusterRequest(input *UpdateClusterInput) (req *request.Request, output *UpdateClusterOutput)

UpdateClusterRequest generates a "aws/request.Request" representing the client's request for the UpdateCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateCluster for more information on using the UpdateCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateClusterRequest method.
req, resp := client.UpdateClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-elastic-2022-11-28/UpdateCluster

func (*DocDBElastic) UpdateClusterWithContext 

func (c *DocDBElastic) UpdateClusterWithContext(ctx aws.Context, input *UpdateClusterInput, opts ...request.Option) (*UpdateClusterOutput, error)

UpdateClusterWithContext is the same as UpdateCluster with the addition of the ability to pass a context and additional request options.

See UpdateCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type GetClusterInput 

type GetClusterInput struct {

	// The ARN identifier of the elastic cluster.
	//
	// ClusterArn is a required field
	ClusterArn *string `location:"uri" locationName:"clusterArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetClusterInput) GoString 

func (s GetClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetClusterInput) SetClusterArn 

func (s *GetClusterInput) SetClusterArn(v string) *GetClusterInput

SetClusterArn sets the ClusterArn field's value.

func (GetClusterInput) String 

func (s GetClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetClusterInput) Validate 

func (s *GetClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetClusterOutput 

type GetClusterOutput struct {

	// Returns information about a specific elastic cluster.
	//
	// Cluster is a required field
	Cluster *Cluster `locationName:"cluster" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetClusterOutput) GoString 

func (s GetClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetClusterOutput) SetCluster 

func (s *GetClusterOutput) SetCluster(v *Cluster) *GetClusterOutput

SetCluster sets the Cluster field's value.

func (GetClusterOutput) String 

func (s GetClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetClusterSnapshotInput 

type GetClusterSnapshotInput struct {

	// The ARN identifier of the elastic cluster snapshot.
	//
	// SnapshotArn is a required field
	SnapshotArn *string `location:"uri" locationName:"snapshotArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetClusterSnapshotInput) GoString 

func (s GetClusterSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetClusterSnapshotInput) SetSnapshotArn 

func (s *GetClusterSnapshotInput) SetSnapshotArn(v string) *GetClusterSnapshotInput

SetSnapshotArn sets the SnapshotArn field's value.

func (GetClusterSnapshotInput) String 

func (s GetClusterSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetClusterSnapshotInput) Validate 

func (s *GetClusterSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetClusterSnapshotOutput 

type GetClusterSnapshotOutput struct {

	// Returns information about a specific elastic cluster snapshot.
	//
	// Snapshot is a required field
	Snapshot *ClusterSnapshot `locationName:"snapshot" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetClusterSnapshotOutput) GoString 

func (s GetClusterSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetClusterSnapshotOutput) SetSnapshot 

func (s *GetClusterSnapshotOutput) SetSnapshot(v *ClusterSnapshot) *GetClusterSnapshotOutput

SetSnapshot sets the Snapshot field's value.

func (GetClusterSnapshotOutput) String 

func (s GetClusterSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

There was an internal server error.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListClusterSnapshotsInput 

type ListClusterSnapshotsInput struct {

	// The ARN identifier of the elastic cluster.
	ClusterArn *string `location:"querystring" locationName:"clusterArn" type:"string"`

	// The maximum number of elastic cluster snapshot results to receive in the
	// response.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"20" type:"integer"`

	// A pagination token provided by a previous request. If this parameter is specified,
	// the response includes only records beyond this token, up to the value specified
	// by max-results.
	//
	// If there is no more data in the responce, the nextToken will not be returned.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// The type of cluster snapshots to be returned. You can specify one of the
	// following values:
	//
	//    * automated - Return all cluster snapshots that Amazon DocumentDB has
	//    automatically created for your Amazon Web Services account.
	//
	//    * manual - Return all cluster snapshots that you have manually created
	//    for your Amazon Web Services account.
	SnapshotType *string `location:"querystring" locationName:"snapshotType" type:"string"`
	// contains filtered or unexported fields
}

func (ListClusterSnapshotsInput) GoString 

func (s ListClusterSnapshotsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListClusterSnapshotsInput) SetClusterArn 

func (s *ListClusterSnapshotsInput) SetClusterArn(v string) *ListClusterSnapshotsInput

SetClusterArn sets the ClusterArn field's value.

func (*ListClusterSnapshotsInput) SetMaxResults 

func (s *ListClusterSnapshotsInput) SetMaxResults(v int64) *ListClusterSnapshotsInput

SetMaxResults sets the MaxResults field's value.

func (*ListClusterSnapshotsInput) SetNextToken 

func (s *ListClusterSnapshotsInput) SetNextToken(v string) *ListClusterSnapshotsInput

SetNextToken sets the NextToken field's value.

func (*ListClusterSnapshotsInput) SetSnapshotType added in v1.50.29 

func (s *ListClusterSnapshotsInput) SetSnapshotType(v string) *ListClusterSnapshotsInput

SetSnapshotType sets the SnapshotType field's value.

func (ListClusterSnapshotsInput) String 

func (s ListClusterSnapshotsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListClusterSnapshotsInput) Validate 

func (s *ListClusterSnapshotsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListClusterSnapshotsOutput 

type ListClusterSnapshotsOutput struct {

	// A pagination token provided by a previous request. If this parameter is specified,
	// the response includes only records beyond this token, up to the value specified
	// by max-results.
	//
	// If there is no more data in the responce, the nextToken will not be returned.
	NextToken *string `locationName:"nextToken" type:"string"`

	// A list of snapshots for a specified elastic cluster.
	Snapshots []*ClusterSnapshotInList `locationName:"snapshots" type:"list"`
	// contains filtered or unexported fields
}

func (ListClusterSnapshotsOutput) GoString 

func (s ListClusterSnapshotsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListClusterSnapshotsOutput) SetNextToken 

func (s *ListClusterSnapshotsOutput) SetNextToken(v string) *ListClusterSnapshotsOutput

SetNextToken sets the NextToken field's value.

func (*ListClusterSnapshotsOutput) SetSnapshots 

func (s *ListClusterSnapshotsOutput) SetSnapshots(v []*ClusterSnapshotInList) *ListClusterSnapshotsOutput

SetSnapshots sets the Snapshots field's value.

func (ListClusterSnapshotsOutput) String 

func (s ListClusterSnapshotsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListClustersInput 

type ListClustersInput struct {

	// The maximum number of elastic cluster snapshot results to receive in the
	// response.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// A pagination token provided by a previous request. If this parameter is specified,
	// the response includes only records beyond this token, up to the value specified
	// by max-results.
	//
	// If there is no more data in the responce, the nextToken will not be returned.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListClustersInput) GoString 

func (s ListClustersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListClustersInput) SetMaxResults 

func (s *ListClustersInput) SetMaxResults(v int64) *ListClustersInput

SetMaxResults sets the MaxResults field's value.

func (*ListClustersInput) SetNextToken 

func (s *ListClustersInput) SetNextToken(v string) *ListClustersInput

SetNextToken sets the NextToken field's value.

func (ListClustersInput) String 

func (s ListClustersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListClustersInput) Validate 

func (s *ListClustersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListClustersOutput 

type ListClustersOutput struct {

	// A list of Amazon DocumentDB elastic clusters.
	Clusters []*ClusterInList `locationName:"clusters" type:"list"`

	// A pagination token provided by a previous request. If this parameter is specified,
	// the response includes only records beyond this token, up to the value specified
	// by max-results.
	//
	// If there is no more data in the responce, the nextToken will not be returned.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListClustersOutput) GoString 

func (s ListClustersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListClustersOutput) SetClusters 

func (s *ListClustersOutput) SetClusters(v []*ClusterInList) *ListClustersOutput

SetClusters sets the Clusters field's value.

func (*ListClustersOutput) SetNextToken 

func (s *ListClustersOutput) SetNextToken(v string) *ListClustersOutput

SetNextToken sets the NextToken field's value.

func (ListClustersOutput) String 

func (s ListClustersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The ARN identifier of the elastic cluster resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// The list of tags for the specified elastic cluster resource.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// An error message describing the failure.
	Message_ *string `locationName:"message" type:"string"`

	// The ID of the resource that could not be located.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// The type of the resource that could not be found.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The specified resource could not be located.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RestoreClusterFromSnapshotInput 

type RestoreClusterFromSnapshotInput struct {

	// The name of the elastic cluster.
	//
	// ClusterName is a required field
	ClusterName *string `locationName:"clusterName" type:"string" required:"true"`

	// The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic
	// clusters cluster.
	//
	// The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption
	// key. If you are creating a cluster using the same Amazon account that owns
	// this KMS encryption key, you can use the KMS key alias instead of the ARN
	// as the KMS encryption key.
	//
	// If an encryption key is not specified here, Amazon DocumentDB uses the default
	// encryption key that KMS creates for your account. Your account has a different
	// default encryption key for each Amazon Region.
	KmsKeyId *string `locationName:"kmsKeyId" type:"string"`

	// The capacity of each shard in the new restored elastic cluster.
	ShardCapacity *int64 `locationName:"shardCapacity" type:"integer"`

	// The number of replica instances applying to all shards in the elastic cluster.
	// A shardInstanceCount value of 1 means there is one writer instance, and any
	// additional instances are replicas that can be used for reads and to improve
	// availability.
	ShardInstanceCount *int64 `locationName:"shardInstanceCount" type:"integer"`

	// The ARN identifier of the elastic cluster snapshot.
	//
	// SnapshotArn is a required field
	SnapshotArn *string `location:"uri" locationName:"snapshotArn" type:"string" required:"true"`

	// The Amazon EC2 subnet IDs for the elastic cluster.
	SubnetIds []*string `locationName:"subnetIds" type:"list"`

	// A list of the tag names to be assigned to the restored elastic cluster, in
	// the form of an array of key-value pairs in which the key is the tag name
	// and the value is the key value.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// A list of EC2 VPC security groups to associate with the elastic cluster.
	VpcSecurityGroupIds []*string `locationName:"vpcSecurityGroupIds" type:"list"`
	// contains filtered or unexported fields
}

func (RestoreClusterFromSnapshotInput) GoString 

func (s RestoreClusterFromSnapshotInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreClusterFromSnapshotInput) SetClusterName 

func (s *RestoreClusterFromSnapshotInput) SetClusterName(v string) *RestoreClusterFromSnapshotInput

SetClusterName sets the ClusterName field's value.

func (*RestoreClusterFromSnapshotInput) SetKmsKeyId 

func (s *RestoreClusterFromSnapshotInput) SetKmsKeyId(v string) *RestoreClusterFromSnapshotInput

SetKmsKeyId sets the KmsKeyId field's value.

func (*RestoreClusterFromSnapshotInput) SetShardCapacity added in v1.50.29 

func (s *RestoreClusterFromSnapshotInput) SetShardCapacity(v int64) *RestoreClusterFromSnapshotInput

SetShardCapacity sets the ShardCapacity field's value.

func (*RestoreClusterFromSnapshotInput) SetShardInstanceCount added in v1.50.29 

func (s *RestoreClusterFromSnapshotInput) SetShardInstanceCount(v int64) *RestoreClusterFromSnapshotInput

SetShardInstanceCount sets the ShardInstanceCount field's value.

func (*RestoreClusterFromSnapshotInput) SetSnapshotArn 

func (s *RestoreClusterFromSnapshotInput) SetSnapshotArn(v string) *RestoreClusterFromSnapshotInput

SetSnapshotArn sets the SnapshotArn field's value.

func (*RestoreClusterFromSnapshotInput) SetSubnetIds 

func (s *RestoreClusterFromSnapshotInput) SetSubnetIds(v []*string) *RestoreClusterFromSnapshotInput

SetSubnetIds sets the SubnetIds field's value.

func (*RestoreClusterFromSnapshotInput) SetTags 

func (s *RestoreClusterFromSnapshotInput) SetTags(v map[string]*string) *RestoreClusterFromSnapshotInput

SetTags sets the Tags field's value.

func (*RestoreClusterFromSnapshotInput) SetVpcSecurityGroupIds 

func (s *RestoreClusterFromSnapshotInput) SetVpcSecurityGroupIds(v []*string) *RestoreClusterFromSnapshotInput

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (RestoreClusterFromSnapshotInput) String 

func (s RestoreClusterFromSnapshotInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreClusterFromSnapshotInput) Validate 

func (s *RestoreClusterFromSnapshotInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RestoreClusterFromSnapshotOutput 

type RestoreClusterFromSnapshotOutput struct {

	// Returns information about a the restored elastic cluster.
	//
	// Cluster is a required field
	Cluster *Cluster `locationName:"cluster" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (RestoreClusterFromSnapshotOutput) GoString 

func (s RestoreClusterFromSnapshotOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RestoreClusterFromSnapshotOutput) SetCluster 

func (s *RestoreClusterFromSnapshotOutput) SetCluster(v *Cluster) *RestoreClusterFromSnapshotOutput

SetCluster sets the Cluster field's value.

func (RestoreClusterFromSnapshotOutput) String 

func (s RestoreClusterFromSnapshotOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

The service quota for the action was exceeded.

func (*ServiceQuotaExceededException) Code 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode 

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String 

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Shard added in v1.50.29 

type Shard struct {

	// The time when the shard was created in Universal Coordinated Time (UTC).
	//
	// CreateTime is a required field
	CreateTime *string `locationName:"createTime" type:"string" required:"true"`

	// The ID of the shard.
	//
	// ShardId is a required field
	ShardId *string `locationName:"shardId" type:"string" required:"true"`

	// The current status of the shard.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"Status"`
	// contains filtered or unexported fields
}

The name of the shard.

func (Shard) GoString added in v1.50.29 

func (s Shard) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Shard) SetCreateTime added in v1.50.29 

func (s *Shard) SetCreateTime(v string) *Shard

SetCreateTime sets the CreateTime field's value.

func (*Shard) SetShardId added in v1.50.29 

func (s *Shard) SetShardId(v string) *Shard

SetShardId sets the ShardId field's value.

func (*Shard) SetStatus added in v1.50.29 

func (s *Shard) SetStatus(v string) *Shard

SetStatus sets the Status field's value.

func (Shard) String added in v1.50.29 

func (s Shard) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartClusterInput added in v1.50.29 

type StartClusterInput struct {

	// The ARN identifier of the elastic cluster.
	//
	// ClusterArn is a required field
	ClusterArn *string `location:"uri" locationName:"clusterArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartClusterInput) GoString added in v1.50.29 

func (s StartClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartClusterInput) SetClusterArn added in v1.50.29 

func (s *StartClusterInput) SetClusterArn(v string) *StartClusterInput

SetClusterArn sets the ClusterArn field's value.

func (StartClusterInput) String added in v1.50.29 

func (s StartClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartClusterInput) Validate added in v1.50.29 

func (s *StartClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartClusterOutput added in v1.50.29 

type StartClusterOutput struct {

	// Returns information about a specific elastic cluster.
	//
	// Cluster is a required field
	Cluster *Cluster `locationName:"cluster" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StartClusterOutput) GoString added in v1.50.29 

func (s StartClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartClusterOutput) SetCluster added in v1.50.29 

func (s *StartClusterOutput) SetCluster(v *Cluster) *StartClusterOutput

SetCluster sets the Cluster field's value.

func (StartClusterOutput) String added in v1.50.29 

func (s StartClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopClusterInput added in v1.50.29 

type StopClusterInput struct {

	// The ARN identifier of the elastic cluster.
	//
	// ClusterArn is a required field
	ClusterArn *string `location:"uri" locationName:"clusterArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopClusterInput) GoString added in v1.50.29 

func (s StopClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopClusterInput) SetClusterArn added in v1.50.29 

func (s *StopClusterInput) SetClusterArn(v string) *StopClusterInput

SetClusterArn sets the ClusterArn field's value.

func (StopClusterInput) String added in v1.50.29 

func (s StopClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopClusterInput) Validate added in v1.50.29 

func (s *StopClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopClusterOutput added in v1.50.29 

type StopClusterOutput struct {

	// Returns information about a specific elastic cluster.
	//
	// Cluster is a required field
	Cluster *Cluster `locationName:"cluster" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (StopClusterOutput) GoString added in v1.50.29 

func (s StopClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StopClusterOutput) SetCluster added in v1.50.29 

func (s *StopClusterOutput) SetCluster(v *Cluster) *StopClusterOutput

SetCluster sets the Cluster field's value.

func (StopClusterOutput) String added in v1.50.29 

func (s StopClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput 

type TagResourceInput struct {

	// The ARN identifier of the elastic cluster resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// The tags that are assigned to the elastic cluster resource.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags 

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput 

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

func (TagResourceOutput) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`

	// The number of seconds to wait before retrying the operation.
	RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"`
	// contains filtered or unexported fields
}

ThrottlingException will be thrown when request was denied due to request throttling.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput 

type UntagResourceInput struct {

	// The ARN identifier of the elastic cluster resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" min:"1" type:"string" required:"true"`

	// The tag keys to be removed from the elastic cluster resource.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput 

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

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateClusterInput 

type UpdateClusterInput struct {

	// The password associated with the elastic cluster administrator. This password
	// can contain any printable ASCII character except forward slash (/), double
	// quote ("), or the "at" symbol (@).
	//
	// Constraints: Must contain from 8 to 100 characters.
	//
	// AdminUserPassword is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateClusterInput's
	// String and GoString methods.
	AdminUserPassword *string `locationName:"adminUserPassword" type:"string" sensitive:"true"`

	// The authentication type used to determine where to fetch the password used
	// for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN.
	AuthType *string `locationName:"authType" type:"string" enum:"Auth"`

	// The number of days for which automatic snapshots are retained.
	BackupRetentionPeriod *int64 `locationName:"backupRetentionPeriod" type:"integer"`

	// The client token for the elastic cluster.
	ClientToken *string `locationName:"clientToken" type:"string" idempotencyToken:"true"`

	// The ARN identifier of the elastic cluster.
	//
	// ClusterArn is a required field
	ClusterArn *string `location:"uri" locationName:"clusterArn" type:"string" required:"true"`

	// The daily time range during which automated backups are created if automated
	// backups are enabled, as determined by the backupRetentionPeriod.
	PreferredBackupWindow *string `locationName:"preferredBackupWindow" type:"string"`

	// The weekly time range during which system maintenance can occur, in Universal
	// Coordinated Time (UTC).
	//
	// Format: ddd:hh24:mi-ddd:hh24:mi
	//
	// Default: a 30-minute window selected at random from an 8-hour block of time
	// for each Amazon Web Services Region, occurring on a random day of the week.
	//
	// Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
	//
	// Constraints: Minimum 30-minute window.
	PreferredMaintenanceWindow *string `locationName:"preferredMaintenanceWindow" type:"string"`

	// The number of vCPUs assigned to each elastic cluster shard. Maximum is 64.
	// Allowed values are 2, 4, 8, 16, 32, 64.
	ShardCapacity *int64 `locationName:"shardCapacity" type:"integer"`

	// The number of shards assigned to the elastic cluster. Maximum is 32.
	ShardCount *int64 `locationName:"shardCount" type:"integer"`

	// The number of replica instances applying to all shards in the elastic cluster.
	// A shardInstanceCount value of 1 means there is one writer instance, and any
	// additional instances are replicas that can be used for reads and to improve
	// availability.
	ShardInstanceCount *int64 `locationName:"shardInstanceCount" type:"integer"`

	// The Amazon EC2 subnet IDs for the elastic cluster.
	SubnetIds []*string `locationName:"subnetIds" type:"list"`

	// A list of EC2 VPC security groups to associate with the elastic cluster.
	VpcSecurityGroupIds []*string `locationName:"vpcSecurityGroupIds" type:"list"`
	// contains filtered or unexported fields
}

func (UpdateClusterInput) GoString 

func (s UpdateClusterInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateClusterInput) SetAdminUserPassword 

func (s *UpdateClusterInput) SetAdminUserPassword(v string) *UpdateClusterInput

SetAdminUserPassword sets the AdminUserPassword field's value.

func (*UpdateClusterInput) SetAuthType 

func (s *UpdateClusterInput) SetAuthType(v string) *UpdateClusterInput

SetAuthType sets the AuthType field's value.

func (*UpdateClusterInput) SetBackupRetentionPeriod added in v1.50.29 

func (s *UpdateClusterInput) SetBackupRetentionPeriod(v int64) *UpdateClusterInput

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*UpdateClusterInput) SetClientToken 

func (s *UpdateClusterInput) SetClientToken(v string) *UpdateClusterInput

SetClientToken sets the ClientToken field's value.

func (*UpdateClusterInput) SetClusterArn 

func (s *UpdateClusterInput) SetClusterArn(v string) *UpdateClusterInput

SetClusterArn sets the ClusterArn field's value.

func (*UpdateClusterInput) SetPreferredBackupWindow added in v1.50.29 

func (s *UpdateClusterInput) SetPreferredBackupWindow(v string) *UpdateClusterInput

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*UpdateClusterInput) SetPreferredMaintenanceWindow 

func (s *UpdateClusterInput) SetPreferredMaintenanceWindow(v string) *UpdateClusterInput

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*UpdateClusterInput) SetShardCapacity 

func (s *UpdateClusterInput) SetShardCapacity(v int64) *UpdateClusterInput

SetShardCapacity sets the ShardCapacity field's value.

func (*UpdateClusterInput) SetShardCount 

func (s *UpdateClusterInput) SetShardCount(v int64) *UpdateClusterInput

SetShardCount sets the ShardCount field's value.

func (*UpdateClusterInput) SetShardInstanceCount added in v1.50.29 

func (s *UpdateClusterInput) SetShardInstanceCount(v int64) *UpdateClusterInput

SetShardInstanceCount sets the ShardInstanceCount field's value.

func (*UpdateClusterInput) SetSubnetIds 

func (s *UpdateClusterInput) SetSubnetIds(v []*string) *UpdateClusterInput

SetSubnetIds sets the SubnetIds field's value.

func (*UpdateClusterInput) SetVpcSecurityGroupIds 

func (s *UpdateClusterInput) SetVpcSecurityGroupIds(v []*string) *UpdateClusterInput

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (UpdateClusterInput) String 

func (s UpdateClusterInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateClusterInput) Validate 

func (s *UpdateClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateClusterOutput 

type UpdateClusterOutput struct {

	// Returns information about the updated elastic cluster.
	//
	// Cluster is a required field
	Cluster *Cluster `locationName:"cluster" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateClusterOutput) GoString 

func (s UpdateClusterOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateClusterOutput) SetCluster 

func (s *UpdateClusterOutput) SetCluster(v *Cluster) *UpdateClusterOutput

SetCluster sets the Cluster field's value.

func (UpdateClusterOutput) String 

func (s UpdateClusterOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A list of the fields in which the validation exception occurred.
	FieldList []*ValidationExceptionField `locationName:"fieldList" type:"list"`

	// An error message describing the validation exception.
	Message_ *string `locationName:"message" type:"string"`

	// The reason why the validation exception occurred (one of unknownOperation,
	// cannotParse, fieldValidationFailed, or other).
	//
	// Reason is a required field
	Reason *string `locationName:"reason" type:"string" required:"true" enum:"ValidationExceptionReason"`
	// contains filtered or unexported fields
}

A structure defining a validation exception.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationExceptionField 

type ValidationExceptionField struct {

	// An error message describing the validation exception in this field.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`

	// The name of the field where the validation exception occurred.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A specific field in which a given validation exception occurred.

func (ValidationExceptionField) GoString 

func (s ValidationExceptionField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationExceptionField) SetMessage 

func (s *ValidationExceptionField) SetMessage(v string) *ValidationExceptionField

SetMessage sets the Message field's value.

func (*ValidationExceptionField) SetName 

func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField

SetName sets the Name field's value.

func (ValidationExceptionField) String 

func (s ValidationExceptionField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package docdbelasticiface provides an interface to enable mocking the Amazon DocumentDB Elastic Clusters service client for testing your code.
 Package docdbelasticiface provides an interface to enable mocking the Amazon DocumentDB Elastic Clusters service client for testing your code.

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.