docdb

package
v1.51.8 Latest Latest
Warning

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

 Go to latest Published: Mar 26, 2024 License: Apache-2.0 Imports: 11 Imported by: 57

Documentation

Overview

Package docdb provides the client and types for making API requests to Amazon DocumentDB with MongoDB compatibility.

Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud. With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.

See https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31 for more information on this service.

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

Using the Client

To contact Amazon DocumentDB with MongoDB compatibility 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 with MongoDB compatibility client DocDB for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/docdb/#New

Index

Constants

View Source 
const (
	// ApplyMethodImmediate is a ApplyMethod enum value
	ApplyMethodImmediate = "immediate"

	// ApplyMethodPendingReboot is a ApplyMethod enum value
	ApplyMethodPendingReboot = "pending-reboot"
)
View Source 
const (
	// SourceTypeDbInstance is a SourceType enum value
	SourceTypeDbInstance = "db-instance"

	// SourceTypeDbParameterGroup is a SourceType enum value
	SourceTypeDbParameterGroup = "db-parameter-group"

	// SourceTypeDbSecurityGroup is a SourceType enum value
	SourceTypeDbSecurityGroup = "db-security-group"

	// SourceTypeDbSnapshot is a SourceType enum value
	SourceTypeDbSnapshot = "db-snapshot"

	// SourceTypeDbCluster is a SourceType enum value
	SourceTypeDbCluster = "db-cluster"

	// SourceTypeDbClusterSnapshot is a SourceType enum value
	SourceTypeDbClusterSnapshot = "db-cluster-snapshot"
)
View Source 
const (

	// ErrCodeAuthorizationNotFoundFault for service response error code
	// "AuthorizationNotFound".
	//
	// The specified CIDR IP or Amazon EC2 security group isn't authorized for the
	// specified security group.
	//
	// Amazon DocumentDB also might not be authorized to perform necessary actions
	// on your behalf using IAM.
	ErrCodeAuthorizationNotFoundFault = "AuthorizationNotFound"

	// ErrCodeCertificateNotFoundFault for service response error code
	// "CertificateNotFound".
	//
	// CertificateIdentifier doesn't refer to an existing certificate.
	ErrCodeCertificateNotFoundFault = "CertificateNotFound"

	// ErrCodeDBClusterAlreadyExistsFault for service response error code
	// "DBClusterAlreadyExistsFault".
	//
	// You already have a cluster with the given identifier.
	ErrCodeDBClusterAlreadyExistsFault = "DBClusterAlreadyExistsFault"

	// ErrCodeDBClusterNotFoundFault for service response error code
	// "DBClusterNotFoundFault".
	//
	// DBClusterIdentifier doesn't refer to an existing cluster.
	ErrCodeDBClusterNotFoundFault = "DBClusterNotFoundFault"

	// ErrCodeDBClusterParameterGroupNotFoundFault for service response error code
	// "DBClusterParameterGroupNotFound".
	//
	// DBClusterParameterGroupName doesn't refer to an existing cluster parameter
	// group.
	ErrCodeDBClusterParameterGroupNotFoundFault = "DBClusterParameterGroupNotFound"

	// ErrCodeDBClusterQuotaExceededFault for service response error code
	// "DBClusterQuotaExceededFault".
	//
	// The cluster can't be created because you have reached the maximum allowed
	// quota of clusters.
	ErrCodeDBClusterQuotaExceededFault = "DBClusterQuotaExceededFault"

	// ErrCodeDBClusterSnapshotAlreadyExistsFault for service response error code
	// "DBClusterSnapshotAlreadyExistsFault".
	//
	// You already have a cluster snapshot with the given identifier.
	ErrCodeDBClusterSnapshotAlreadyExistsFault = "DBClusterSnapshotAlreadyExistsFault"

	// ErrCodeDBClusterSnapshotNotFoundFault for service response error code
	// "DBClusterSnapshotNotFoundFault".
	//
	// DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.
	ErrCodeDBClusterSnapshotNotFoundFault = "DBClusterSnapshotNotFoundFault"

	// ErrCodeDBInstanceAlreadyExistsFault for service response error code
	// "DBInstanceAlreadyExists".
	//
	// You already have a instance with the given identifier.
	ErrCodeDBInstanceAlreadyExistsFault = "DBInstanceAlreadyExists"

	// ErrCodeDBInstanceNotFoundFault for service response error code
	// "DBInstanceNotFound".
	//
	// DBInstanceIdentifier doesn't refer to an existing instance.
	ErrCodeDBInstanceNotFoundFault = "DBInstanceNotFound"

	// ErrCodeDBParameterGroupAlreadyExistsFault for service response error code
	// "DBParameterGroupAlreadyExists".
	//
	// A parameter group with the same name already exists.
	ErrCodeDBParameterGroupAlreadyExistsFault = "DBParameterGroupAlreadyExists"

	// ErrCodeDBParameterGroupNotFoundFault for service response error code
	// "DBParameterGroupNotFound".
	//
	// DBParameterGroupName doesn't refer to an existing parameter group.
	ErrCodeDBParameterGroupNotFoundFault = "DBParameterGroupNotFound"

	// ErrCodeDBParameterGroupQuotaExceededFault for service response error code
	// "DBParameterGroupQuotaExceeded".
	//
	// This request would cause you to exceed the allowed number of parameter groups.
	ErrCodeDBParameterGroupQuotaExceededFault = "DBParameterGroupQuotaExceeded"

	// ErrCodeDBSecurityGroupNotFoundFault for service response error code
	// "DBSecurityGroupNotFound".
	//
	// DBSecurityGroupName doesn't refer to an existing security group.
	ErrCodeDBSecurityGroupNotFoundFault = "DBSecurityGroupNotFound"

	// ErrCodeDBSnapshotAlreadyExistsFault for service response error code
	// "DBSnapshotAlreadyExists".
	//
	// DBSnapshotIdentifier is already being used by an existing snapshot.
	ErrCodeDBSnapshotAlreadyExistsFault = "DBSnapshotAlreadyExists"

	// ErrCodeDBSnapshotNotFoundFault for service response error code
	// "DBSnapshotNotFound".
	//
	// DBSnapshotIdentifier doesn't refer to an existing snapshot.
	ErrCodeDBSnapshotNotFoundFault = "DBSnapshotNotFound"

	// ErrCodeDBSubnetGroupAlreadyExistsFault for service response error code
	// "DBSubnetGroupAlreadyExists".
	//
	// DBSubnetGroupName is already being used by an existing subnet group.
	ErrCodeDBSubnetGroupAlreadyExistsFault = "DBSubnetGroupAlreadyExists"

	// ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs for service response error code
	// "DBSubnetGroupDoesNotCoverEnoughAZs".
	//
	// Subnets in the subnet group should cover at least two Availability Zones
	// unless there is only one Availability Zone.
	ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs = "DBSubnetGroupDoesNotCoverEnoughAZs"

	// ErrCodeDBSubnetGroupNotFoundFault for service response error code
	// "DBSubnetGroupNotFoundFault".
	//
	// DBSubnetGroupName doesn't refer to an existing subnet group.
	ErrCodeDBSubnetGroupNotFoundFault = "DBSubnetGroupNotFoundFault"

	// ErrCodeDBSubnetGroupQuotaExceededFault for service response error code
	// "DBSubnetGroupQuotaExceeded".
	//
	// The request would cause you to exceed the allowed number of subnet groups.
	ErrCodeDBSubnetGroupQuotaExceededFault = "DBSubnetGroupQuotaExceeded"

	// ErrCodeDBSubnetQuotaExceededFault for service response error code
	// "DBSubnetQuotaExceededFault".
	//
	// The request would cause you to exceed the allowed number of subnets in a
	// subnet group.
	ErrCodeDBSubnetQuotaExceededFault = "DBSubnetQuotaExceededFault"

	// ErrCodeDBUpgradeDependencyFailureFault for service response error code
	// "DBUpgradeDependencyFailure".
	//
	// The upgrade failed because a resource that the depends on can't be modified.
	ErrCodeDBUpgradeDependencyFailureFault = "DBUpgradeDependencyFailure"

	// ErrCodeEventSubscriptionQuotaExceededFault for service response error code
	// "EventSubscriptionQuotaExceeded".
	//
	// You have reached the maximum number of event subscriptions.
	ErrCodeEventSubscriptionQuotaExceededFault = "EventSubscriptionQuotaExceeded"

	// ErrCodeGlobalClusterAlreadyExistsFault for service response error code
	// "GlobalClusterAlreadyExistsFault".
	//
	// The GlobalClusterIdentifier already exists. Choose a new global cluster identifier
	// (unique name) to create a new global cluster.
	ErrCodeGlobalClusterAlreadyExistsFault = "GlobalClusterAlreadyExistsFault"

	// ErrCodeGlobalClusterNotFoundFault for service response error code
	// "GlobalClusterNotFoundFault".
	//
	// The GlobalClusterIdentifier doesn't refer to an existing global cluster.
	ErrCodeGlobalClusterNotFoundFault = "GlobalClusterNotFoundFault"

	// ErrCodeGlobalClusterQuotaExceededFault for service response error code
	// "GlobalClusterQuotaExceededFault".
	//
	// The number of global clusters for this account is already at the maximum
	// allowed.
	ErrCodeGlobalClusterQuotaExceededFault = "GlobalClusterQuotaExceededFault"

	// ErrCodeInstanceQuotaExceededFault for service response error code
	// "InstanceQuotaExceeded".
	//
	// The request would cause you to exceed the allowed number of instances.
	ErrCodeInstanceQuotaExceededFault = "InstanceQuotaExceeded"

	// ErrCodeInsufficientDBClusterCapacityFault for service response error code
	// "InsufficientDBClusterCapacityFault".
	//
	// The cluster doesn't have enough capacity for the current operation.
	ErrCodeInsufficientDBClusterCapacityFault = "InsufficientDBClusterCapacityFault"

	// ErrCodeInsufficientDBInstanceCapacityFault for service response error code
	// "InsufficientDBInstanceCapacity".
	//
	// The specified instance class isn't available in the specified Availability
	// Zone.
	ErrCodeInsufficientDBInstanceCapacityFault = "InsufficientDBInstanceCapacity"

	// ErrCodeInsufficientStorageClusterCapacityFault for service response error code
	// "InsufficientStorageClusterCapacity".
	//
	// There is not enough storage available for the current action. You might be
	// able to resolve this error by updating your subnet group to use different
	// Availability Zones that have more storage available.
	ErrCodeInsufficientStorageClusterCapacityFault = "InsufficientStorageClusterCapacity"

	// ErrCodeInvalidDBClusterSnapshotStateFault for service response error code
	// "InvalidDBClusterSnapshotStateFault".
	//
	// The provided value isn't a valid cluster snapshot state.
	ErrCodeInvalidDBClusterSnapshotStateFault = "InvalidDBClusterSnapshotStateFault"

	// ErrCodeInvalidDBClusterStateFault for service response error code
	// "InvalidDBClusterStateFault".
	//
	// The cluster isn't in a valid state.
	ErrCodeInvalidDBClusterStateFault = "InvalidDBClusterStateFault"

	// ErrCodeInvalidDBInstanceStateFault for service response error code
	// "InvalidDBInstanceState".
	//
	// The specified instance isn't in the available state.
	ErrCodeInvalidDBInstanceStateFault = "InvalidDBInstanceState"

	// ErrCodeInvalidDBParameterGroupStateFault for service response error code
	// "InvalidDBParameterGroupState".
	//
	// The parameter group is in use, or it is in a state that is not valid. If
	// you are trying to delete the parameter group, you can't delete it when the
	// parameter group is in this state.
	ErrCodeInvalidDBParameterGroupStateFault = "InvalidDBParameterGroupState"

	// ErrCodeInvalidDBSecurityGroupStateFault for service response error code
	// "InvalidDBSecurityGroupState".
	//
	// The state of the security group doesn't allow deletion.
	ErrCodeInvalidDBSecurityGroupStateFault = "InvalidDBSecurityGroupState"

	// ErrCodeInvalidDBSnapshotStateFault for service response error code
	// "InvalidDBSnapshotState".
	//
	// The state of the snapshot doesn't allow deletion.
	ErrCodeInvalidDBSnapshotStateFault = "InvalidDBSnapshotState"

	// ErrCodeInvalidDBSubnetGroupStateFault for service response error code
	// "InvalidDBSubnetGroupStateFault".
	//
	// The subnet group can't be deleted because it's in use.
	ErrCodeInvalidDBSubnetGroupStateFault = "InvalidDBSubnetGroupStateFault"

	// ErrCodeInvalidDBSubnetStateFault for service response error code
	// "InvalidDBSubnetStateFault".
	//
	// The subnet isn't in the available state.
	ErrCodeInvalidDBSubnetStateFault = "InvalidDBSubnetStateFault"

	// ErrCodeInvalidEventSubscriptionStateFault for service response error code
	// "InvalidEventSubscriptionState".
	//
	// Someone else might be modifying a subscription. Wait a few seconds, and try
	// again.
	ErrCodeInvalidEventSubscriptionStateFault = "InvalidEventSubscriptionState"

	// ErrCodeInvalidGlobalClusterStateFault for service response error code
	// "InvalidGlobalClusterStateFault".
	//
	// The requested operation can't be performed while the cluster is in this state.
	ErrCodeInvalidGlobalClusterStateFault = "InvalidGlobalClusterStateFault"

	// ErrCodeInvalidRestoreFault for service response error code
	// "InvalidRestoreFault".
	//
	// You cannot restore from a virtual private cloud (VPC) backup to a non-VPC
	// DB instance.
	ErrCodeInvalidRestoreFault = "InvalidRestoreFault"

	// ErrCodeInvalidSubnet for service response error code
	// "InvalidSubnet".
	//
	// The requested subnet is not valid, or multiple subnets were requested that
	// are not all in a common virtual private cloud (VPC).
	ErrCodeInvalidSubnet = "InvalidSubnet"

	// ErrCodeInvalidVPCNetworkStateFault for service response error code
	// "InvalidVPCNetworkStateFault".
	//
	// The subnet group doesn't cover all Availability Zones after it is created
	// because of changes that were made.
	ErrCodeInvalidVPCNetworkStateFault = "InvalidVPCNetworkStateFault"

	// ErrCodeKMSKeyNotAccessibleFault for service response error code
	// "KMSKeyNotAccessibleFault".
	//
	// An error occurred when accessing an KMS key.
	ErrCodeKMSKeyNotAccessibleFault = "KMSKeyNotAccessibleFault"

	// ErrCodeResourceNotFoundFault for service response error code
	// "ResourceNotFoundFault".
	//
	// The specified resource ID was not found.
	ErrCodeResourceNotFoundFault = "ResourceNotFoundFault"

	// ErrCodeSNSInvalidTopicFault for service response error code
	// "SNSInvalidTopic".
	//
	// Amazon SNS has responded that there is a problem with the specified topic.
	ErrCodeSNSInvalidTopicFault = "SNSInvalidTopic"

	// ErrCodeSNSNoAuthorizationFault for service response error code
	// "SNSNoAuthorization".
	//
	// You do not have permission to publish to the SNS topic Amazon Resource Name
	// (ARN).
	ErrCodeSNSNoAuthorizationFault = "SNSNoAuthorization"

	// ErrCodeSNSTopicArnNotFoundFault for service response error code
	// "SNSTopicArnNotFound".
	//
	// The SNS topic Amazon Resource Name (ARN) does not exist.
	ErrCodeSNSTopicArnNotFoundFault = "SNSTopicArnNotFound"

	// ErrCodeSharedSnapshotQuotaExceededFault for service response error code
	// "SharedSnapshotQuotaExceeded".
	//
	// You have exceeded the maximum number of accounts that you can share a manual
	// DB snapshot with.
	ErrCodeSharedSnapshotQuotaExceededFault = "SharedSnapshotQuotaExceeded"

	// ErrCodeSnapshotQuotaExceededFault for service response error code
	// "SnapshotQuotaExceeded".
	//
	// The request would cause you to exceed the allowed number of snapshots.
	ErrCodeSnapshotQuotaExceededFault = "SnapshotQuotaExceeded"

	// ErrCodeSourceNotFoundFault for service response error code
	// "SourceNotFound".
	//
	// The requested source could not be found.
	ErrCodeSourceNotFoundFault = "SourceNotFound"

	// ErrCodeStorageQuotaExceededFault for service response error code
	// "StorageQuotaExceeded".
	//
	// The request would cause you to exceed the allowed amount of storage available
	// across all instances.
	ErrCodeStorageQuotaExceededFault = "StorageQuotaExceeded"

	// ErrCodeStorageTypeNotSupportedFault for service response error code
	// "StorageTypeNotSupported".
	//
	// Storage of the specified StorageType can't be associated with the DB instance.
	ErrCodeStorageTypeNotSupportedFault = "StorageTypeNotSupported"

	// ErrCodeSubnetAlreadyInUse for service response error code
	// "SubnetAlreadyInUse".
	//
	// The subnet is already in use in the Availability Zone.
	ErrCodeSubnetAlreadyInUse = "SubnetAlreadyInUse"

	// ErrCodeSubscriptionAlreadyExistFault for service response error code
	// "SubscriptionAlreadyExist".
	//
	// The provided subscription name already exists.
	ErrCodeSubscriptionAlreadyExistFault = "SubscriptionAlreadyExist"

	// ErrCodeSubscriptionCategoryNotFoundFault for service response error code
	// "SubscriptionCategoryNotFound".
	//
	// The provided category does not exist.
	ErrCodeSubscriptionCategoryNotFoundFault = "SubscriptionCategoryNotFound"

	// ErrCodeSubscriptionNotFoundFault for service response error code
	// "SubscriptionNotFound".
	//
	// The subscription name does not exist.
	ErrCodeSubscriptionNotFoundFault = "SubscriptionNotFound"
)
View Source 
const (
	ServiceName = "DocDB" // Name of service.
	EndpointsID = "rds"   // ID to lookup a service endpoint with.
	ServiceID   = "DocDB" // ServiceID is a unique identifier of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

func ApplyMethod_Values added in v1.34.3 

func ApplyMethod_Values() []string

ApplyMethod_Values returns all elements of the ApplyMethod enum

func SourceType_Values added in v1.34.3 

func SourceType_Values() []string

SourceType_Values returns all elements of the SourceType enum

Types

type AddSourceIdentifierToSubscriptionInput added in v1.38.8 

type AddSourceIdentifierToSubscriptionInput struct {

	// The identifier of the event source to be added:
	//
	//    * If the source type is an instance, a DBInstanceIdentifier must be provided.
	//
	//    * If the source type is a security group, a DBSecurityGroupName must be
	//    provided.
	//
	//    * If the source type is a parameter group, a DBParameterGroupName must
	//    be provided.
	//
	//    * If the source type is a snapshot, a DBSnapshotIdentifier must be provided.
	//
	// SourceIdentifier is a required field
	SourceIdentifier *string `type:"string" required:"true"`

	// The name of the Amazon DocumentDB event notification subscription that you
	// want to add a source identifier to.
	//
	// SubscriptionName is a required field
	SubscriptionName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to AddSourceIdentifierToSubscription.

func (AddSourceIdentifierToSubscriptionInput) GoString added in v1.38.8 

func (s AddSourceIdentifierToSubscriptionInput) 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 (*AddSourceIdentifierToSubscriptionInput) SetSourceIdentifier added in v1.38.8 

func (s *AddSourceIdentifierToSubscriptionInput) SetSourceIdentifier(v string) *AddSourceIdentifierToSubscriptionInput

SetSourceIdentifier sets the SourceIdentifier field's value.

func (*AddSourceIdentifierToSubscriptionInput) SetSubscriptionName added in v1.38.8 

func (s *AddSourceIdentifierToSubscriptionInput) SetSubscriptionName(v string) *AddSourceIdentifierToSubscriptionInput

SetSubscriptionName sets the SubscriptionName field's value.

func (AddSourceIdentifierToSubscriptionInput) String added in v1.38.8 

func (s AddSourceIdentifierToSubscriptionInput) 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 (*AddSourceIdentifierToSubscriptionInput) Validate added in v1.38.8 

func (s *AddSourceIdentifierToSubscriptionInput) Validate() error

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

type AddSourceIdentifierToSubscriptionOutput added in v1.38.8 

type AddSourceIdentifierToSubscriptionOutput struct {

	// Detailed information about an event to which you have subscribed.
	EventSubscription *EventSubscription `type:"structure"`
	// contains filtered or unexported fields
}

func (AddSourceIdentifierToSubscriptionOutput) GoString added in v1.38.8 

func (s AddSourceIdentifierToSubscriptionOutput) 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 (*AddSourceIdentifierToSubscriptionOutput) SetEventSubscription added in v1.38.8 

func (s *AddSourceIdentifierToSubscriptionOutput) SetEventSubscription(v *EventSubscription) *AddSourceIdentifierToSubscriptionOutput

SetEventSubscription sets the EventSubscription field's value.

func (AddSourceIdentifierToSubscriptionOutput) String added in v1.38.8 

func (s AddSourceIdentifierToSubscriptionOutput) 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 AddTagsToResourceInput 

type AddTagsToResourceInput struct {

	// The Amazon DocumentDB resource that the tags are added to. This value is
	// an Amazon Resource Name .
	//
	// ResourceName is a required field
	ResourceName *string `type:"string" required:"true"`

	// The tags to be assigned to the Amazon DocumentDB resource.
	//
	// Tags is a required field
	Tags []*Tag `locationNameList:"Tag" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to AddTagsToResource.

func (AddTagsToResourceInput) GoString 

func (s AddTagsToResourceInput) 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 (*AddTagsToResourceInput) SetResourceName 

func (s *AddTagsToResourceInput) SetResourceName(v string) *AddTagsToResourceInput

SetResourceName sets the ResourceName field's value.

func (*AddTagsToResourceInput) SetTags 

func (s *AddTagsToResourceInput) SetTags(v []*Tag) *AddTagsToResourceInput

SetTags sets the Tags field's value.

func (AddTagsToResourceInput) String 

func (s AddTagsToResourceInput) 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 (*AddTagsToResourceInput) Validate 

func (s *AddTagsToResourceInput) Validate() error

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

type AddTagsToResourceOutput 

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

func (AddTagsToResourceOutput) GoString 

func (s AddTagsToResourceOutput) 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 (AddTagsToResourceOutput) String 

func (s AddTagsToResourceOutput) 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 ApplyPendingMaintenanceActionInput 

type ApplyPendingMaintenanceActionInput struct {

	// The pending maintenance action to apply to this resource.
	//
	// Valid values: system-update, db-upgrade
	//
	// ApplyAction is a required field
	ApplyAction *string `type:"string" required:"true"`

	// A value that specifies the type of opt-in request or undoes an opt-in request.
	// An opt-in request of type immediate can't be undone.
	//
	// Valid values:
	//
	//    * immediate - Apply the maintenance action immediately.
	//
	//    * next-maintenance - Apply the maintenance action during the next maintenance
	//    window for the resource.
	//
	//    * undo-opt-in - Cancel any existing next-maintenance opt-in requests.
	//
	// OptInType is a required field
	OptInType *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the resource that the pending maintenance
	// action applies to.
	//
	// ResourceIdentifier is a required field
	ResourceIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to ApplyPendingMaintenanceAction.

func (ApplyPendingMaintenanceActionInput) GoString 

func (s ApplyPendingMaintenanceActionInput) 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 (*ApplyPendingMaintenanceActionInput) SetApplyAction 

func (s *ApplyPendingMaintenanceActionInput) SetApplyAction(v string) *ApplyPendingMaintenanceActionInput

SetApplyAction sets the ApplyAction field's value.

func (*ApplyPendingMaintenanceActionInput) SetOptInType 

func (s *ApplyPendingMaintenanceActionInput) SetOptInType(v string) *ApplyPendingMaintenanceActionInput

SetOptInType sets the OptInType field's value.

func (*ApplyPendingMaintenanceActionInput) SetResourceIdentifier 

func (s *ApplyPendingMaintenanceActionInput) SetResourceIdentifier(v string) *ApplyPendingMaintenanceActionInput

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (ApplyPendingMaintenanceActionInput) String 

func (s ApplyPendingMaintenanceActionInput) 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 (*ApplyPendingMaintenanceActionInput) Validate 

func (s *ApplyPendingMaintenanceActionInput) Validate() error

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

type ApplyPendingMaintenanceActionOutput 

type ApplyPendingMaintenanceActionOutput struct {

	// Represents the output of ApplyPendingMaintenanceAction.
	ResourcePendingMaintenanceActions *ResourcePendingMaintenanceActions `type:"structure"`
	// contains filtered or unexported fields
}

func (ApplyPendingMaintenanceActionOutput) GoString 

func (s ApplyPendingMaintenanceActionOutput) 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 (*ApplyPendingMaintenanceActionOutput) SetResourcePendingMaintenanceActions 

func (s *ApplyPendingMaintenanceActionOutput) SetResourcePendingMaintenanceActions(v *ResourcePendingMaintenanceActions) *ApplyPendingMaintenanceActionOutput

SetResourcePendingMaintenanceActions sets the ResourcePendingMaintenanceActions field's value.

func (ApplyPendingMaintenanceActionOutput) String 

func (s ApplyPendingMaintenanceActionOutput) 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 AvailabilityZone 

type AvailabilityZone struct {

	// The name of the Availability Zone.
	Name *string `type:"string"`
	// contains filtered or unexported fields
}

Information about an Availability Zone.

func (AvailabilityZone) GoString 

func (s AvailabilityZone) 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 (*AvailabilityZone) SetName 

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

SetName sets the Name field's value.

func (AvailabilityZone) String 

func (s AvailabilityZone) 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 Certificate added in v1.25.3 

type Certificate struct {

	// The Amazon Resource Name (ARN) for the certificate.
	//
	// Example: arn:aws:rds:us-east-1::cert:rds-ca-2019
	CertificateArn *string `type:"string"`

	// The unique key that identifies a certificate.
	//
	// Example: rds-ca-2019
	CertificateIdentifier *string `type:"string"`

	// The type of the certificate.
	//
	// Example: CA
	CertificateType *string `type:"string"`

	// The thumbprint of the certificate.
	Thumbprint *string `type:"string"`

	// The starting date-time from which the certificate is valid.
	//
	// Example: 2019-07-31T17:57:09Z
	ValidFrom *time.Time `type:"timestamp"`

	// The date-time after which the certificate is no longer valid.
	//
	// Example: 2024-07-31T17:57:09Z
	ValidTill *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

A certificate authority (CA) certificate for an Amazon Web Services account.

func (Certificate) GoString added in v1.25.3 

func (s Certificate) 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 (*Certificate) SetCertificateArn added in v1.25.3 

func (s *Certificate) SetCertificateArn(v string) *Certificate

SetCertificateArn sets the CertificateArn field's value.

func (*Certificate) SetCertificateIdentifier added in v1.25.3 

func (s *Certificate) SetCertificateIdentifier(v string) *Certificate

SetCertificateIdentifier sets the CertificateIdentifier field's value.

func (*Certificate) SetCertificateType added in v1.25.3 

func (s *Certificate) SetCertificateType(v string) *Certificate

SetCertificateType sets the CertificateType field's value.

func (*Certificate) SetThumbprint added in v1.25.3 

func (s *Certificate) SetThumbprint(v string) *Certificate

SetThumbprint sets the Thumbprint field's value.

func (*Certificate) SetValidFrom added in v1.25.3 

func (s *Certificate) SetValidFrom(v time.Time) *Certificate

SetValidFrom sets the ValidFrom field's value.

func (*Certificate) SetValidTill added in v1.25.3 

func (s *Certificate) SetValidTill(v time.Time) *Certificate

SetValidTill sets the ValidTill field's value.

func (Certificate) String added in v1.25.3 

func (s Certificate) 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 CertificateDetails added in v1.47.4 

type CertificateDetails struct {

	// The CA identifier of the CA certificate used for the DB instance's server
	// certificate.
	CAIdentifier *string `type:"string"`

	// The expiration date of the DB instance’s server certificate.
	ValidTill *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Returns the details of the DB instance’s server certificate.

For more information, see Updating Your Amazon DocumentDB TLS Certificates (https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) and Encrypting Data in Transit (https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) in the Amazon DocumentDB Developer Guide.

func (CertificateDetails) GoString added in v1.47.4 

func (s CertificateDetails) 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 (*CertificateDetails) SetCAIdentifier added in v1.47.4 

func (s *CertificateDetails) SetCAIdentifier(v string) *CertificateDetails

SetCAIdentifier sets the CAIdentifier field's value.

func (*CertificateDetails) SetValidTill added in v1.47.4 

func (s *CertificateDetails) SetValidTill(v time.Time) *CertificateDetails

SetValidTill sets the ValidTill field's value.

func (CertificateDetails) String added in v1.47.4 

func (s CertificateDetails) 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 CloudwatchLogsExportConfiguration 

type CloudwatchLogsExportConfiguration struct {

	// The list of log types to disable.
	DisableLogTypes []*string `type:"list"`

	// The list of log types to enable.
	EnableLogTypes []*string `type:"list"`
	// contains filtered or unexported fields
}

The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific instance or cluster.

The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the engine that is being used.

func (CloudwatchLogsExportConfiguration) GoString 

func (s CloudwatchLogsExportConfiguration) 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 (*CloudwatchLogsExportConfiguration) SetDisableLogTypes 

func (s *CloudwatchLogsExportConfiguration) SetDisableLogTypes(v []*string) *CloudwatchLogsExportConfiguration

SetDisableLogTypes sets the DisableLogTypes field's value.

func (*CloudwatchLogsExportConfiguration) SetEnableLogTypes 

func (s *CloudwatchLogsExportConfiguration) SetEnableLogTypes(v []*string) *CloudwatchLogsExportConfiguration

SetEnableLogTypes sets the EnableLogTypes field's value.

func (CloudwatchLogsExportConfiguration) String 

func (s CloudwatchLogsExportConfiguration) 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 CopyDBClusterParameterGroupInput 

type CopyDBClusterParameterGroupInput struct {

	// The identifier or Amazon Resource Name (ARN) for the source cluster parameter
	// group.
	//
	// Constraints:
	//
	//    * Must specify a valid cluster parameter group.
	//
	//    * If the source cluster parameter group is in the same Amazon Web Services
	//    Region as the copy, specify a valid parameter group identifier; for example,
	//    my-db-cluster-param-group, or a valid ARN.
	//
	//    * If the source parameter group is in a different Amazon Web Services
	//    Region than the copy, specify a valid cluster parameter group ARN; for
	//    example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.
	//
	// SourceDBClusterParameterGroupIdentifier is a required field
	SourceDBClusterParameterGroupIdentifier *string `type:"string" required:"true"`

	// The tags that are to be assigned to the parameter group.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// A description for the copied cluster parameter group.
	//
	// TargetDBClusterParameterGroupDescription is a required field
	TargetDBClusterParameterGroupDescription *string `type:"string" required:"true"`

	// The identifier for the copied cluster parameter group.
	//
	// Constraints:
	//
	//    * Cannot be null, empty, or blank.
	//
	//    * Must contain from 1 to 255 letters, numbers, or hyphens.
	//
	//    * The first character must be a letter.
	//
	//    * Cannot end with a hyphen or contain two consecutive hyphens.
	//
	// Example: my-cluster-param-group1
	//
	// TargetDBClusterParameterGroupIdentifier is a required field
	TargetDBClusterParameterGroupIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to CopyDBClusterParameterGroup.

func (CopyDBClusterParameterGroupInput) GoString 

func (s CopyDBClusterParameterGroupInput) 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 (*CopyDBClusterParameterGroupInput) SetSourceDBClusterParameterGroupIdentifier 

func (s *CopyDBClusterParameterGroupInput) SetSourceDBClusterParameterGroupIdentifier(v string) *CopyDBClusterParameterGroupInput

SetSourceDBClusterParameterGroupIdentifier sets the SourceDBClusterParameterGroupIdentifier field's value.

func (*CopyDBClusterParameterGroupInput) SetTags 

func (s *CopyDBClusterParameterGroupInput) SetTags(v []*Tag) *CopyDBClusterParameterGroupInput

SetTags sets the Tags field's value.

func (*CopyDBClusterParameterGroupInput) SetTargetDBClusterParameterGroupDescription 

func (s *CopyDBClusterParameterGroupInput) SetTargetDBClusterParameterGroupDescription(v string) *CopyDBClusterParameterGroupInput

SetTargetDBClusterParameterGroupDescription sets the TargetDBClusterParameterGroupDescription field's value.

func (*CopyDBClusterParameterGroupInput) SetTargetDBClusterParameterGroupIdentifier 

func (s *CopyDBClusterParameterGroupInput) SetTargetDBClusterParameterGroupIdentifier(v string) *CopyDBClusterParameterGroupInput

SetTargetDBClusterParameterGroupIdentifier sets the TargetDBClusterParameterGroupIdentifier field's value.

func (CopyDBClusterParameterGroupInput) String 

func (s CopyDBClusterParameterGroupInput) 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 (*CopyDBClusterParameterGroupInput) Validate 

func (s *CopyDBClusterParameterGroupInput) Validate() error

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

type CopyDBClusterParameterGroupOutput 

type CopyDBClusterParameterGroupOutput struct {

	// Detailed information about a cluster parameter group.
	DBClusterParameterGroup *DBClusterParameterGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CopyDBClusterParameterGroupOutput) GoString 

func (s CopyDBClusterParameterGroupOutput) 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 (*CopyDBClusterParameterGroupOutput) SetDBClusterParameterGroup 

func (s *CopyDBClusterParameterGroupOutput) SetDBClusterParameterGroup(v *DBClusterParameterGroup) *CopyDBClusterParameterGroupOutput

SetDBClusterParameterGroup sets the DBClusterParameterGroup field's value.

func (CopyDBClusterParameterGroupOutput) String 

func (s CopyDBClusterParameterGroupOutput) 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 CopyDBClusterSnapshotInput 

type CopyDBClusterSnapshotInput struct {

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

	// DestinationRegion is used for presigning the request to a given region.
	DestinationRegion *string `type:"string"`

	// The KMS key ID for an encrypted cluster snapshot. The KMS key ID is the Amazon
	// Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS
	// encryption key.
	//
	// If you copy an encrypted cluster snapshot from your Amazon Web Services account,
	// you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption
	// key. If you don't specify a value for KmsKeyId, then the copy of the cluster
	// snapshot is encrypted with the same KMS key as the source cluster snapshot.
	//
	// If you copy an encrypted cluster snapshot that is shared from another Amazon
	// Web Services account, then you must specify a value for KmsKeyId.
	//
	// To copy an encrypted cluster snapshot to another Amazon Web Services Region,
	// set KmsKeyId to the KMS key ID that you want to use to encrypt the copy of
	// the cluster snapshot in the destination Region. 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 cluster snapshot and specify a value for the KmsKeyId
	// parameter, an error is returned.
	KmsKeyId *string `type:"string"`

	// The URL that contains a Signature Version 4 signed request for theCopyDBClusterSnapshot
	// API action in the Amazon Web Services Region that contains the source cluster
	// snapshot to copy. You must use the PreSignedUrl parameter when copying a
	// cluster snapshot from another Amazon Web Services Region.
	//
	// If you are using an Amazon Web Services SDK tool or the CLI, you can specify
	// SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl
	// manually. Specifying SourceRegion autogenerates a pre-signed URL that is
	// a valid request for the operation that can be executed in the source Amazon
	// Web Services Region.
	//
	// The presigned URL must be a valid request for the CopyDBClusterSnapshot API
	// action that can be executed in the source Amazon Web Services Region that
	// contains the cluster snapshot to be copied. The presigned URL request must
	// contain the following parameter values:
	//
	//    * SourceRegion - The ID of the region that contains the snapshot to be
	//    copied.
	//
	//    * SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted
	//    cluster snapshot to be copied. This identifier must be in the Amazon Resource
	//    Name (ARN) format for the source Amazon Web Services Region. For example,
	//    if you are copying an encrypted cluster snapshot from the us-east-1 Amazon
	//    Web Services Region, then your SourceDBClusterSnapshotIdentifier looks
	//    something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.
	//
	//    * TargetDBClusterSnapshotIdentifier - The identifier for the new cluster
	//    snapshot to be created. This parameter isn't case sensitive.
	PreSignedUrl *string `type:"string"`

	// The identifier of the cluster snapshot to copy. This parameter is not case
	// sensitive.
	//
	// Constraints:
	//
	//    * Must specify a valid system snapshot in the available state.
	//
	//    * If the source snapshot is in the same Amazon Web Services Region as
	//    the copy, specify a valid snapshot identifier.
	//
	//    * If the source snapshot is in a different Amazon Web Services Region
	//    than the copy, specify a valid cluster snapshot ARN.
	//
	// Example: my-cluster-snapshot1
	//
	// SourceDBClusterSnapshotIdentifier is a required field
	SourceDBClusterSnapshotIdentifier *string `type:"string" required:"true"`

	// SourceRegion is the source region where the resource exists. This is not
	// sent over the wire and is only used for presigning. This value should always
	// have the same region as the source ARN.
	SourceRegion *string `type:"string" ignore:"true"`

	// The tags to be assigned to the cluster snapshot.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// The identifier of the new 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: my-cluster-snapshot2
	//
	// TargetDBClusterSnapshotIdentifier is a required field
	TargetDBClusterSnapshotIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to CopyDBClusterSnapshot.

func (CopyDBClusterSnapshotInput) GoString 

func (s CopyDBClusterSnapshotInput) 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 (*CopyDBClusterSnapshotInput) SetCopyTags 

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

SetCopyTags sets the CopyTags field's value.

func (*CopyDBClusterSnapshotInput) SetDestinationRegion added in v1.37.14 

func (s *CopyDBClusterSnapshotInput) SetDestinationRegion(v string) *CopyDBClusterSnapshotInput

SetDestinationRegion sets the DestinationRegion field's value.

func (*CopyDBClusterSnapshotInput) SetKmsKeyId 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*CopyDBClusterSnapshotInput) SetPreSignedUrl 

func (s *CopyDBClusterSnapshotInput) SetPreSignedUrl(v string) *CopyDBClusterSnapshotInput

SetPreSignedUrl sets the PreSignedUrl field's value.

func (*CopyDBClusterSnapshotInput) SetSourceDBClusterSnapshotIdentifier 

func (s *CopyDBClusterSnapshotInput) SetSourceDBClusterSnapshotIdentifier(v string) *CopyDBClusterSnapshotInput

SetSourceDBClusterSnapshotIdentifier sets the SourceDBClusterSnapshotIdentifier field's value.

func (*CopyDBClusterSnapshotInput) SetSourceRegion added in v1.37.14 

func (s *CopyDBClusterSnapshotInput) SetSourceRegion(v string) *CopyDBClusterSnapshotInput

SetSourceRegion sets the SourceRegion field's value.

func (*CopyDBClusterSnapshotInput) SetTags 

func (s *CopyDBClusterSnapshotInput) SetTags(v []*Tag) *CopyDBClusterSnapshotInput

SetTags sets the Tags field's value.

func (*CopyDBClusterSnapshotInput) SetTargetDBClusterSnapshotIdentifier 

func (s *CopyDBClusterSnapshotInput) SetTargetDBClusterSnapshotIdentifier(v string) *CopyDBClusterSnapshotInput

SetTargetDBClusterSnapshotIdentifier sets the TargetDBClusterSnapshotIdentifier field's value.

func (CopyDBClusterSnapshotInput) String 

func (s CopyDBClusterSnapshotInput) 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 (*CopyDBClusterSnapshotInput) Validate 

func (s *CopyDBClusterSnapshotInput) Validate() error

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

type CopyDBClusterSnapshotOutput 

type CopyDBClusterSnapshotOutput struct {

	// Detailed information about a cluster snapshot.
	DBClusterSnapshot *DBClusterSnapshot `type:"structure"`
	// contains filtered or unexported fields
}

func (CopyDBClusterSnapshotOutput) GoString 

func (s CopyDBClusterSnapshotOutput) 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 (*CopyDBClusterSnapshotOutput) SetDBClusterSnapshot 

func (s *CopyDBClusterSnapshotOutput) SetDBClusterSnapshot(v *DBClusterSnapshot) *CopyDBClusterSnapshotOutput

SetDBClusterSnapshot sets the DBClusterSnapshot field's value.

func (CopyDBClusterSnapshotOutput) String 

func (s CopyDBClusterSnapshotOutput) 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 CreateDBClusterInput 

type CreateDBClusterInput struct {

	// A list of Amazon EC2 Availability Zones that instances in the cluster can
	// be created in.
	AvailabilityZones []*string `locationNameList:"AvailabilityZone" type:"list"`

	// The number of days for which automated backups are retained. You must specify
	// a minimum value of 1.
	//
	// Default: 1
	//
	// Constraints:
	//
	//    * Must be a value from 1 to 35.
	BackupRetentionPeriod *int64 `type:"integer"`

	// The cluster identifier. 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
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The name of the cluster parameter group to associate with this cluster.
	DBClusterParameterGroupName *string `type:"string"`

	// A subnet group to associate with this cluster.
	//
	// Constraints: Must match the name of an existing DBSubnetGroup. Must not be
	// default.
	//
	// Example: mySubnetgroup
	DBSubnetGroupName *string `type:"string"`

	// Specifies whether this cluster can be deleted. If DeletionProtection is enabled,
	// the cluster cannot be deleted unless it is modified and DeletionProtection
	// is disabled. DeletionProtection protects clusters from being accidentally
	// deleted.
	DeletionProtection *bool `type:"boolean"`

	// DestinationRegion is used for presigning the request to a given region.
	DestinationRegion *string `type:"string"`

	// A list of log types that need to be enabled for exporting to Amazon CloudWatch
	// Logs. You can enable audit logs or profiler logs. For more information, see
	// Auditing Amazon DocumentDB Events (https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html)
	// and Profiling Amazon DocumentDB Operations (https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html).
	EnableCloudwatchLogsExports []*string `type:"list"`

	// The name of the database engine to be used for this cluster.
	//
	// Valid values: docdb
	//
	// Engine is a required field
	Engine *string `type:"string" required:"true"`

	// The version number of the database engine to use. The --engine-version will
	// default to the latest major engine version. For production workloads, we
	// recommend explicitly declaring this parameter with the intended major engine
	// version.
	EngineVersion *string `type:"string"`

	// The cluster identifier of the new global cluster.
	GlobalClusterIdentifier *string `min:"1" type:"string"`

	// The KMS key identifier for an encrypted 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 Web Services account
	// that owns the KMS encryption key that is used to encrypt the new cluster,
	// you can use the KMS key alias instead of the ARN for the KMS encryption key.
	//
	// If an encryption key is not specified in KmsKeyId:
	//
	//    * If the StorageEncrypted parameter is true, Amazon DocumentDB uses your
	//    default encryption key.
	//
	// KMS creates the default encryption key for your Amazon Web Services account.
	// Your Amazon Web Services account has a different default encryption key for
	// each Amazon Web Services Regions.
	KmsKeyId *string `type:"string"`

	// The password for the master database user. 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.
	MasterUserPassword *string `type:"string"`

	// The name of the master user for the cluster.
	//
	// Constraints:
	//
	//    * Must be from 1 to 63 letters or numbers.
	//
	//    * The first character must be a letter.
	//
	//    * Cannot be a reserved word for the chosen database engine.
	MasterUsername *string `type:"string"`

	// The port number on which the instances in the cluster accept connections.
	Port *int64 `type:"integer"`

	// Not currently supported.
	PreSignedUrl *string `type:"string"`

	// The daily time range during which automated backups are created if automated
	// backups are enabled using the BackupRetentionPeriod parameter.
	//
	// The default is a 30-minute window selected at random from an 8-hour block
	// of time for each Amazon Web Services Region.
	//
	// Constraints:
	//
	//    * Must be in the format hh24:mi-hh24:mi.
	//
	//    * Must be in Universal Coordinated Time (UTC).
	//
	//    * Must not conflict with the preferred maintenance window.
	//
	//    * Must be at least 30 minutes.
	PreferredBackupWindow *string `type:"string"`

	// The weekly time range during which system maintenance can occur, in Universal
	// Coordinated Time (UTC).
	//
	// Format: ddd:hh24:mi-ddd:hh24:mi
	//
	// The default is 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 `type:"string"`

	// SourceRegion is the source region where the resource exists. This is not
	// sent over the wire and is only used for presigning. This value should always
	// have the same region as the source ARN.
	SourceRegion *string `type:"string" ignore:"true"`

	// Specifies whether the cluster is encrypted.
	StorageEncrypted *bool `type:"boolean"`

	// The storage type to associate with the DB cluster.
	//
	// For information on storage types for Amazon DocumentDB clusters, see Cluster
	// storage configurations in the Amazon DocumentDB Developer Guide.
	//
	// Valid values for storage type - standard | iopt1
	//
	// Default value is standard
	//
	// When you create a DocumentDB DB cluster with the storage type set to iopt1,
	// the storage type is returned in the response. The storage type isn't returned
	// when you set it to standard.
	StorageType *string `type:"string"`

	// The tags to be assigned to the cluster.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

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

Represents the input to CreateDBCluster.

func (CreateDBClusterInput) GoString 

func (s CreateDBClusterInput) 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 (*CreateDBClusterInput) SetAvailabilityZones 

func (s *CreateDBClusterInput) SetAvailabilityZones(v []*string) *CreateDBClusterInput

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*CreateDBClusterInput) SetBackupRetentionPeriod 

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*CreateDBClusterInput) SetDBClusterIdentifier 

func (s *CreateDBClusterInput) SetDBClusterIdentifier(v string) *CreateDBClusterInput

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*CreateDBClusterInput) SetDBClusterParameterGroupName 

func (s *CreateDBClusterInput) SetDBClusterParameterGroupName(v string) *CreateDBClusterInput

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*CreateDBClusterInput) SetDBSubnetGroupName 

func (s *CreateDBClusterInput) SetDBSubnetGroupName(v string) *CreateDBClusterInput

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*CreateDBClusterInput) SetDeletionProtection added in v1.20.13 

func (s *CreateDBClusterInput) SetDeletionProtection(v bool) *CreateDBClusterInput

SetDeletionProtection sets the DeletionProtection field's value.

func (*CreateDBClusterInput) SetDestinationRegion added in v1.37.14 

func (s *CreateDBClusterInput) SetDestinationRegion(v string) *CreateDBClusterInput

SetDestinationRegion sets the DestinationRegion field's value.

func (*CreateDBClusterInput) SetEnableCloudwatchLogsExports 

func (s *CreateDBClusterInput) SetEnableCloudwatchLogsExports(v []*string) *CreateDBClusterInput

SetEnableCloudwatchLogsExports sets the EnableCloudwatchLogsExports field's value.

func (*CreateDBClusterInput) SetEngine 

func (s *CreateDBClusterInput) SetEngine(v string) *CreateDBClusterInput

SetEngine sets the Engine field's value.

func (*CreateDBClusterInput) SetEngineVersion 

func (s *CreateDBClusterInput) SetEngineVersion(v string) *CreateDBClusterInput

SetEngineVersion sets the EngineVersion field's value.

func (*CreateDBClusterInput) SetGlobalClusterIdentifier added in v1.38.53 

func (s *CreateDBClusterInput) SetGlobalClusterIdentifier(v string) *CreateDBClusterInput

SetGlobalClusterIdentifier sets the GlobalClusterIdentifier field's value.

func (*CreateDBClusterInput) SetKmsKeyId 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateDBClusterInput) SetMasterUserPassword 

func (s *CreateDBClusterInput) SetMasterUserPassword(v string) *CreateDBClusterInput

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*CreateDBClusterInput) SetMasterUsername 

func (s *CreateDBClusterInput) SetMasterUsername(v string) *CreateDBClusterInput

SetMasterUsername sets the MasterUsername field's value.

func (*CreateDBClusterInput) SetPort 

func (s *CreateDBClusterInput) SetPort(v int64) *CreateDBClusterInput

SetPort sets the Port field's value.

func (*CreateDBClusterInput) SetPreSignedUrl added in v1.34.23 

func (s *CreateDBClusterInput) SetPreSignedUrl(v string) *CreateDBClusterInput

SetPreSignedUrl sets the PreSignedUrl field's value.

func (*CreateDBClusterInput) SetPreferredBackupWindow 

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*CreateDBClusterInput) SetPreferredMaintenanceWindow 

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*CreateDBClusterInput) SetSourceRegion added in v1.37.14 

func (s *CreateDBClusterInput) SetSourceRegion(v string) *CreateDBClusterInput

SetSourceRegion sets the SourceRegion field's value.

func (*CreateDBClusterInput) SetStorageEncrypted 

func (s *CreateDBClusterInput) SetStorageEncrypted(v bool) *CreateDBClusterInput

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*CreateDBClusterInput) SetStorageType added in v1.48.1 

func (s *CreateDBClusterInput) SetStorageType(v string) *CreateDBClusterInput

SetStorageType sets the StorageType field's value.

func (*CreateDBClusterInput) SetTags 

func (s *CreateDBClusterInput) SetTags(v []*Tag) *CreateDBClusterInput

SetTags sets the Tags field's value.

func (*CreateDBClusterInput) SetVpcSecurityGroupIds 

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

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (CreateDBClusterInput) String 

func (s CreateDBClusterInput) 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 (*CreateDBClusterInput) Validate 

func (s *CreateDBClusterInput) Validate() error

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

type CreateDBClusterOutput 

type CreateDBClusterOutput struct {

	// Detailed information about a cluster.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDBClusterOutput) GoString 

func (s CreateDBClusterOutput) 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 (*CreateDBClusterOutput) SetDBCluster 

func (s *CreateDBClusterOutput) SetDBCluster(v *DBCluster) *CreateDBClusterOutput

SetDBCluster sets the DBCluster field's value.

func (CreateDBClusterOutput) String 

func (s CreateDBClusterOutput) 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 CreateDBClusterParameterGroupInput 

type CreateDBClusterParameterGroupInput struct {

	// The name of the cluster parameter group.
	//
	// Constraints:
	//
	//    * Must not match the name of an existing DBClusterParameterGroup.
	//
	// This value is stored as a lowercase string.
	//
	// DBClusterParameterGroupName is a required field
	DBClusterParameterGroupName *string `type:"string" required:"true"`

	// The cluster parameter group family name.
	//
	// DBParameterGroupFamily is a required field
	DBParameterGroupFamily *string `type:"string" required:"true"`

	// The description for the cluster parameter group.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// The tags to be assigned to the cluster parameter group.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

Represents the input of CreateDBClusterParameterGroup.

func (CreateDBClusterParameterGroupInput) GoString 

func (s CreateDBClusterParameterGroupInput) 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 (*CreateDBClusterParameterGroupInput) SetDBClusterParameterGroupName 

func (s *CreateDBClusterParameterGroupInput) SetDBClusterParameterGroupName(v string) *CreateDBClusterParameterGroupInput

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*CreateDBClusterParameterGroupInput) SetDBParameterGroupFamily 

func (s *CreateDBClusterParameterGroupInput) SetDBParameterGroupFamily(v string) *CreateDBClusterParameterGroupInput

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*CreateDBClusterParameterGroupInput) SetDescription 

func (s *CreateDBClusterParameterGroupInput) SetDescription(v string) *CreateDBClusterParameterGroupInput

SetDescription sets the Description field's value.

func (*CreateDBClusterParameterGroupInput) SetTags 

func (s *CreateDBClusterParameterGroupInput) SetTags(v []*Tag) *CreateDBClusterParameterGroupInput

SetTags sets the Tags field's value.

func (CreateDBClusterParameterGroupInput) String 

func (s CreateDBClusterParameterGroupInput) 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 (*CreateDBClusterParameterGroupInput) Validate 

func (s *CreateDBClusterParameterGroupInput) Validate() error

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

type CreateDBClusterParameterGroupOutput 

type CreateDBClusterParameterGroupOutput struct {

	// Detailed information about a cluster parameter group.
	DBClusterParameterGroup *DBClusterParameterGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDBClusterParameterGroupOutput) GoString 

func (s CreateDBClusterParameterGroupOutput) 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 (*CreateDBClusterParameterGroupOutput) SetDBClusterParameterGroup 

func (s *CreateDBClusterParameterGroupOutput) SetDBClusterParameterGroup(v *DBClusterParameterGroup) *CreateDBClusterParameterGroupOutput

SetDBClusterParameterGroup sets the DBClusterParameterGroup field's value.

func (CreateDBClusterParameterGroupOutput) String 

func (s CreateDBClusterParameterGroupOutput) 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 CreateDBClusterSnapshotInput 

type CreateDBClusterSnapshotInput struct {

	// The identifier of the cluster to create a snapshot for. This parameter is
	// not case sensitive.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBCluster.
	//
	// Example: my-cluster
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The identifier of the cluster snapshot. 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-snapshot1
	//
	// DBClusterSnapshotIdentifier is a required field
	DBClusterSnapshotIdentifier *string `type:"string" required:"true"`

	// The tags to be assigned to the cluster snapshot.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

Represents the input of CreateDBClusterSnapshot.

func (CreateDBClusterSnapshotInput) GoString 

func (s CreateDBClusterSnapshotInput) 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 (*CreateDBClusterSnapshotInput) SetDBClusterIdentifier 

func (s *CreateDBClusterSnapshotInput) SetDBClusterIdentifier(v string) *CreateDBClusterSnapshotInput

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*CreateDBClusterSnapshotInput) SetDBClusterSnapshotIdentifier 

func (s *CreateDBClusterSnapshotInput) SetDBClusterSnapshotIdentifier(v string) *CreateDBClusterSnapshotInput

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (*CreateDBClusterSnapshotInput) SetTags 

func (s *CreateDBClusterSnapshotInput) SetTags(v []*Tag) *CreateDBClusterSnapshotInput

SetTags sets the Tags field's value.

func (CreateDBClusterSnapshotInput) String 

func (s CreateDBClusterSnapshotInput) 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 (*CreateDBClusterSnapshotInput) Validate 

func (s *CreateDBClusterSnapshotInput) Validate() error

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

type CreateDBClusterSnapshotOutput 

type CreateDBClusterSnapshotOutput struct {

	// Detailed information about a cluster snapshot.
	DBClusterSnapshot *DBClusterSnapshot `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDBClusterSnapshotOutput) GoString 

func (s CreateDBClusterSnapshotOutput) 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 (*CreateDBClusterSnapshotOutput) SetDBClusterSnapshot 

func (s *CreateDBClusterSnapshotOutput) SetDBClusterSnapshot(v *DBClusterSnapshot) *CreateDBClusterSnapshotOutput

SetDBClusterSnapshot sets the DBClusterSnapshot field's value.

func (CreateDBClusterSnapshotOutput) String 

func (s CreateDBClusterSnapshotOutput) 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 CreateDBInstanceInput 

type CreateDBInstanceInput struct {

	// This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does
	// not perform minor version upgrades regardless of the value set.
	//
	// Default: false
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// The Amazon EC2 Availability Zone that the instance is created in.
	//
	// Default: A random, system-chosen Availability Zone in the endpoint's Amazon
	// Web Services Region.
	//
	// Example: us-east-1d
	AvailabilityZone *string `type:"string"`

	// The CA certificate identifier to use for the DB instance's server certificate.
	//
	// For more information, see Updating Your Amazon DocumentDB TLS Certificates
	// (https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html)
	// and Encrypting Data in Transit (https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)
	// in the Amazon DocumentDB Developer Guide.
	CACertificateIdentifier *string `type:"string"`

	// A value that indicates whether to copy tags from the DB instance to snapshots
	// of the DB instance. By default, tags are not copied.
	CopyTagsToSnapshot *bool `type:"boolean"`

	// The identifier of the cluster that the instance will belong to.
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The compute and memory capacity of the instance; for example, db.r5.large.
	//
	// DBInstanceClass is a required field
	DBInstanceClass *string `type:"string" required:"true"`

	// The instance identifier. 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: mydbinstance
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// A value that indicates whether to enable Performance Insights for the DB
	// Instance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html).
	EnablePerformanceInsights *bool `type:"boolean"`

	// The name of the database engine to be used for this instance.
	//
	// Valid value: docdb
	//
	// Engine is a required field
	Engine *string `type:"string" required:"true"`

	// The KMS key identifier for encryption of Performance Insights data.
	//
	// The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for
	// the KMS key.
	//
	// If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon
	// DocumentDB uses your default KMS key. There is a default KMS key for your
	// Amazon Web Services account. Your Amazon Web Services account has a different
	// default KMS key for each Amazon Web Services region.
	PerformanceInsightsKMSKeyId *string `type:"string"`

	// The time range each week during which system maintenance can occur, in Universal
	// Coordinated Time (UTC).
	//
	// Format: ddd:hh24:mi-ddd:hh24:mi
	//
	// The default is 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 `type:"string"`

	// A value that specifies the order in which an Amazon DocumentDB replica is
	// promoted to the primary instance after a failure of the existing primary
	// instance.
	//
	// Default: 1
	//
	// Valid values: 0-15
	PromotionTier *int64 `type:"integer"`

	// The tags to be assigned to the instance. You can assign up to 10 tags to
	// an instance.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

Represents the input to CreateDBInstance.

func (CreateDBInstanceInput) GoString 

func (s CreateDBInstanceInput) 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 (*CreateDBInstanceInput) SetAutoMinorVersionUpgrade 

func (s *CreateDBInstanceInput) SetAutoMinorVersionUpgrade(v bool) *CreateDBInstanceInput

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*CreateDBInstanceInput) SetAvailabilityZone 

func (s *CreateDBInstanceInput) SetAvailabilityZone(v string) *CreateDBInstanceInput

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*CreateDBInstanceInput) SetCACertificateIdentifier added in v1.47.4 

func (s *CreateDBInstanceInput) SetCACertificateIdentifier(v string) *CreateDBInstanceInput

SetCACertificateIdentifier sets the CACertificateIdentifier field's value.

func (*CreateDBInstanceInput) SetCopyTagsToSnapshot added in v1.44.60 

func (s *CreateDBInstanceInput) SetCopyTagsToSnapshot(v bool) *CreateDBInstanceInput

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*CreateDBInstanceInput) SetDBClusterIdentifier 

func (s *CreateDBInstanceInput) SetDBClusterIdentifier(v string) *CreateDBInstanceInput

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*CreateDBInstanceInput) SetDBInstanceClass 

func (s *CreateDBInstanceInput) SetDBInstanceClass(v string) *CreateDBInstanceInput

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*CreateDBInstanceInput) SetDBInstanceIdentifier 

func (s *CreateDBInstanceInput) SetDBInstanceIdentifier(v string) *CreateDBInstanceInput

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*CreateDBInstanceInput) SetEnablePerformanceInsights added in v1.43.35 

func (s *CreateDBInstanceInput) SetEnablePerformanceInsights(v bool) *CreateDBInstanceInput

SetEnablePerformanceInsights sets the EnablePerformanceInsights field's value.

func (*CreateDBInstanceInput) SetEngine 

func (s *CreateDBInstanceInput) SetEngine(v string) *CreateDBInstanceInput

SetEngine sets the Engine field's value.

func (*CreateDBInstanceInput) SetPerformanceInsightsKMSKeyId added in v1.43.35 

func (s *CreateDBInstanceInput) SetPerformanceInsightsKMSKeyId(v string) *CreateDBInstanceInput

SetPerformanceInsightsKMSKeyId sets the PerformanceInsightsKMSKeyId field's value.

func (*CreateDBInstanceInput) SetPreferredMaintenanceWindow 

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*CreateDBInstanceInput) SetPromotionTier 

func (s *CreateDBInstanceInput) SetPromotionTier(v int64) *CreateDBInstanceInput

SetPromotionTier sets the PromotionTier field's value.

func (*CreateDBInstanceInput) SetTags 

func (s *CreateDBInstanceInput) SetTags(v []*Tag) *CreateDBInstanceInput

SetTags sets the Tags field's value.

func (CreateDBInstanceInput) String 

func (s CreateDBInstanceInput) 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 (*CreateDBInstanceInput) Validate 

func (s *CreateDBInstanceInput) Validate() error

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

type CreateDBInstanceOutput 

type CreateDBInstanceOutput struct {

	// Detailed information about an instance.
	DBInstance *DBInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDBInstanceOutput) GoString 

func (s CreateDBInstanceOutput) 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 (*CreateDBInstanceOutput) SetDBInstance 

func (s *CreateDBInstanceOutput) SetDBInstance(v *DBInstance) *CreateDBInstanceOutput

SetDBInstance sets the DBInstance field's value.

func (CreateDBInstanceOutput) String 

func (s CreateDBInstanceOutput) 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 CreateDBSubnetGroupInput 

type CreateDBSubnetGroupInput struct {

	// The description for the subnet group.
	//
	// DBSubnetGroupDescription is a required field
	DBSubnetGroupDescription *string `type:"string" required:"true"`

	// The name for the subnet group. This value is stored as a lowercase string.
	//
	// Constraints: Must contain no more than 255 letters, numbers, periods, underscores,
	// spaces, or hyphens. Must not be default.
	//
	// Example: mySubnetgroup
	//
	// DBSubnetGroupName is a required field
	DBSubnetGroupName *string `type:"string" required:"true"`

	// The Amazon EC2 subnet IDs for the subnet group.
	//
	// SubnetIds is a required field
	SubnetIds []*string `locationNameList:"SubnetIdentifier" type:"list" required:"true"`

	// The tags to be assigned to the subnet group.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

Represents the input to CreateDBSubnetGroup.

func (CreateDBSubnetGroupInput) GoString 

func (s CreateDBSubnetGroupInput) 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 (*CreateDBSubnetGroupInput) SetDBSubnetGroupDescription 

func (s *CreateDBSubnetGroupInput) SetDBSubnetGroupDescription(v string) *CreateDBSubnetGroupInput

SetDBSubnetGroupDescription sets the DBSubnetGroupDescription field's value.

func (*CreateDBSubnetGroupInput) SetDBSubnetGroupName 

func (s *CreateDBSubnetGroupInput) SetDBSubnetGroupName(v string) *CreateDBSubnetGroupInput

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*CreateDBSubnetGroupInput) SetSubnetIds 

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

SetSubnetIds sets the SubnetIds field's value.

func (*CreateDBSubnetGroupInput) SetTags 

func (s *CreateDBSubnetGroupInput) SetTags(v []*Tag) *CreateDBSubnetGroupInput

SetTags sets the Tags field's value.

func (CreateDBSubnetGroupInput) String 

func (s CreateDBSubnetGroupInput) 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 (*CreateDBSubnetGroupInput) Validate 

func (s *CreateDBSubnetGroupInput) Validate() error

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

type CreateDBSubnetGroupOutput 

type CreateDBSubnetGroupOutput struct {

	// Detailed information about a subnet group.
	DBSubnetGroup *DBSubnetGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateDBSubnetGroupOutput) GoString 

func (s CreateDBSubnetGroupOutput) 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 (*CreateDBSubnetGroupOutput) SetDBSubnetGroup 

func (s *CreateDBSubnetGroupOutput) SetDBSubnetGroup(v *DBSubnetGroup) *CreateDBSubnetGroupOutput

SetDBSubnetGroup sets the DBSubnetGroup field's value.

func (CreateDBSubnetGroupOutput) String 

func (s CreateDBSubnetGroupOutput) 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 CreateEventSubscriptionInput added in v1.38.8 

type CreateEventSubscriptionInput struct {

	// A Boolean value; set to true to activate the subscription, set to false to
	// create the subscription but not active it.
	Enabled *bool `type:"boolean"`

	// A list of event categories for a SourceType that you want to subscribe to.
	EventCategories []*string `locationNameList:"EventCategory" type:"list"`

	// The Amazon Resource Name (ARN) of the SNS topic created for event notification.
	// Amazon SNS creates the ARN when you create a topic and subscribe to it.
	//
	// SnsTopicArn is a required field
	SnsTopicArn *string `type:"string" required:"true"`

	// The list of identifiers of the event sources for which events are returned.
	// If not specified, then all sources are included in the response. An identifier
	// must begin with a letter and must contain only ASCII letters, digits, and
	// hyphens; it can't end with a hyphen or contain two consecutive hyphens.
	//
	// Constraints:
	//
	//    * If SourceIds are provided, SourceType must also be provided.
	//
	//    * If the source type is an instance, a DBInstanceIdentifier must be provided.
	//
	//    * If the source type is a security group, a DBSecurityGroupName must be
	//    provided.
	//
	//    * If the source type is a parameter group, a DBParameterGroupName must
	//    be provided.
	//
	//    * If the source type is a snapshot, a DBSnapshotIdentifier must be provided.
	SourceIds []*string `locationNameList:"SourceId" type:"list"`

	// The type of source that is generating the events. For example, if you want
	// to be notified of events generated by an instance, you would set this parameter
	// to db-instance. If this value is not specified, all events are returned.
	//
	// Valid values: db-instance, db-cluster, db-parameter-group, db-security-group,
	// db-cluster-snapshot
	SourceType *string `type:"string"`

	// The name of the subscription.
	//
	// Constraints: The name must be fewer than 255 characters.
	//
	// SubscriptionName is a required field
	SubscriptionName *string `type:"string" required:"true"`

	// The tags to be assigned to the event subscription.
	Tags []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

Represents the input to CreateEventSubscription.

func (CreateEventSubscriptionInput) GoString added in v1.38.8 

func (s CreateEventSubscriptionInput) 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 (*CreateEventSubscriptionInput) SetEnabled added in v1.38.8 

func (s *CreateEventSubscriptionInput) SetEnabled(v bool) *CreateEventSubscriptionInput

SetEnabled sets the Enabled field's value.

func (*CreateEventSubscriptionInput) SetEventCategories added in v1.38.8 

func (s *CreateEventSubscriptionInput) SetEventCategories(v []*string) *CreateEventSubscriptionInput

SetEventCategories sets the EventCategories field's value.

func (*CreateEventSubscriptionInput) SetSnsTopicArn added in v1.38.8 

func (s *CreateEventSubscriptionInput) SetSnsTopicArn(v string) *CreateEventSubscriptionInput

SetSnsTopicArn sets the SnsTopicArn field's value.

func (*CreateEventSubscriptionInput) SetSourceIds added in v1.38.8 

func (s *CreateEventSubscriptionInput) SetSourceIds(v []*string) *CreateEventSubscriptionInput

SetSourceIds sets the SourceIds field's value.

func (*CreateEventSubscriptionInput) SetSourceType added in v1.38.8 

func (s *CreateEventSubscriptionInput) SetSourceType(v string) *CreateEventSubscriptionInput

SetSourceType sets the SourceType field's value.

func (*CreateEventSubscriptionInput) SetSubscriptionName added in v1.38.8 

func (s *CreateEventSubscriptionInput) SetSubscriptionName(v string) *CreateEventSubscriptionInput

SetSubscriptionName sets the SubscriptionName field's value.

func (*CreateEventSubscriptionInput) SetTags added in v1.38.8 

func (s *CreateEventSubscriptionInput) SetTags(v []*Tag) *CreateEventSubscriptionInput

SetTags sets the Tags field's value.

func (CreateEventSubscriptionInput) String added in v1.38.8 

func (s CreateEventSubscriptionInput) 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 (*CreateEventSubscriptionInput) Validate added in v1.38.8 

func (s *CreateEventSubscriptionInput) Validate() error

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

type CreateEventSubscriptionOutput added in v1.38.8 

type CreateEventSubscriptionOutput struct {

	// Detailed information about an event to which you have subscribed.
	EventSubscription *EventSubscription `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateEventSubscriptionOutput) GoString added in v1.38.8 

func (s CreateEventSubscriptionOutput) 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 (*CreateEventSubscriptionOutput) SetEventSubscription added in v1.38.8 

func (s *CreateEventSubscriptionOutput) SetEventSubscription(v *EventSubscription) *CreateEventSubscriptionOutput

SetEventSubscription sets the EventSubscription field's value.

func (CreateEventSubscriptionOutput) String added in v1.38.8 

func (s CreateEventSubscriptionOutput) 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 CreateGlobalClusterInput added in v1.38.53 

type CreateGlobalClusterInput struct {

	// The name for your database of up to 64 alpha-numeric characters. If you do
	// not provide a name, Amazon DocumentDB will not create a database in the global
	// cluster you are creating.
	DatabaseName *string `type:"string"`

	// The deletion protection setting for the new global cluster. The global cluster
	// can't be deleted when deletion protection is enabled.
	DeletionProtection *bool `type:"boolean"`

	// The name of the database engine to be used for this cluster.
	Engine *string `type:"string"`

	// The engine version of the global cluster.
	EngineVersion *string `type:"string"`

	// The cluster identifier of the new global cluster.
	//
	// GlobalClusterIdentifier is a required field
	GlobalClusterIdentifier *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) to use as the primary cluster of the global
	// cluster. This parameter is optional.
	SourceDBClusterIdentifier *string `type:"string"`

	// The storage encryption setting for the new global cluster.
	StorageEncrypted *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Represents the input to CreateGlobalCluster.

func (CreateGlobalClusterInput) GoString added in v1.38.53 

func (s CreateGlobalClusterInput) 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 (*CreateGlobalClusterInput) SetDatabaseName added in v1.38.53 

func (s *CreateGlobalClusterInput) SetDatabaseName(v string) *CreateGlobalClusterInput

SetDatabaseName sets the DatabaseName field's value.

func (*CreateGlobalClusterInput) SetDeletionProtection added in v1.38.53 

func (s *CreateGlobalClusterInput) SetDeletionProtection(v bool) *CreateGlobalClusterInput

SetDeletionProtection sets the DeletionProtection field's value.

func (*CreateGlobalClusterInput) SetEngine added in v1.38.53 

func (s *CreateGlobalClusterInput) SetEngine(v string) *CreateGlobalClusterInput

SetEngine sets the Engine field's value.

func (*CreateGlobalClusterInput) SetEngineVersion added in v1.38.53 

func (s *CreateGlobalClusterInput) SetEngineVersion(v string) *CreateGlobalClusterInput

SetEngineVersion sets the EngineVersion field's value.

func (*CreateGlobalClusterInput) SetGlobalClusterIdentifier added in v1.38.53 

func (s *CreateGlobalClusterInput) SetGlobalClusterIdentifier(v string) *CreateGlobalClusterInput

SetGlobalClusterIdentifier sets the GlobalClusterIdentifier field's value.

func (*CreateGlobalClusterInput) SetSourceDBClusterIdentifier added in v1.38.53 

func (s *CreateGlobalClusterInput) SetSourceDBClusterIdentifier(v string) *CreateGlobalClusterInput

SetSourceDBClusterIdentifier sets the SourceDBClusterIdentifier field's value.

func (*CreateGlobalClusterInput) SetStorageEncrypted added in v1.38.53 

func (s *CreateGlobalClusterInput) SetStorageEncrypted(v bool) *CreateGlobalClusterInput

SetStorageEncrypted sets the StorageEncrypted field's value.

func (CreateGlobalClusterInput) String added in v1.38.53 

func (s CreateGlobalClusterInput) 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 (*CreateGlobalClusterInput) Validate added in v1.38.53 

func (s *CreateGlobalClusterInput) Validate() error

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

type CreateGlobalClusterOutput added in v1.38.53 

type CreateGlobalClusterOutput struct {

	// A data type representing an Amazon DocumentDB global cluster.
	GlobalCluster *GlobalCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateGlobalClusterOutput) GoString added in v1.38.53 

func (s CreateGlobalClusterOutput) 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 (*CreateGlobalClusterOutput) SetGlobalCluster added in v1.38.53 

func (s *CreateGlobalClusterOutput) SetGlobalCluster(v *GlobalCluster) *CreateGlobalClusterOutput

SetGlobalCluster sets the GlobalCluster field's value.

func (CreateGlobalClusterOutput) String added in v1.38.53 

func (s CreateGlobalClusterOutput) 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 DBCluster 

type DBCluster struct {

	// Provides a list of the Identity and Access Management (IAM) roles that are
	// associated with the cluster. (IAM) roles that are associated with a cluster
	// grant permission for the cluster to access other Amazon Web Services services
	// on your behalf.
	AssociatedRoles []*DBClusterRole `locationNameList:"DBClusterRole" type:"list"`

	// Provides the list of Amazon EC2 Availability Zones that instances in the
	// cluster can be created in.
	AvailabilityZones []*string `locationNameList:"AvailabilityZone" type:"list"`

	// Specifies the number of days for which automatic snapshots are retained.
	BackupRetentionPeriod *int64 `type:"integer"`

	// Identifies the clone group to which the DB cluster is associated.
	CloneGroupId *string `type:"string"`

	// Specifies the time when the cluster was created, in Universal Coordinated
	// Time (UTC).
	ClusterCreateTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) for the cluster.
	DBClusterArn *string `type:"string"`

	// Contains a user-supplied cluster identifier. This identifier is the unique
	// key that identifies a cluster.
	DBClusterIdentifier *string `type:"string"`

	// Provides the list of instances that make up the cluster.
	DBClusterMembers []*DBClusterMember `locationNameList:"DBClusterMember" type:"list"`

	// Specifies the name of the cluster parameter group for the cluster.
	DBClusterParameterGroup *string `type:"string"`

	// Specifies information on the subnet group that is associated with the cluster,
	// including the name, description, and subnets in the subnet group.
	DBSubnetGroup *string `type:"string"`

	// The Amazon Web Services Region-unique, immutable identifier for the cluster.
	// This identifier is found in CloudTrail log entries whenever the KMS key for
	// the cluster is accessed.
	DbClusterResourceId *string `type:"string"`

	// Specifies whether this cluster can be deleted. If DeletionProtection is enabled,
	// the cluster cannot be deleted unless it is modified and DeletionProtection
	// is disabled. DeletionProtection protects clusters from being accidentally
	// deleted.
	DeletionProtection *bool `type:"boolean"`

	// The earliest time to which a database can be restored with point-in-time
	// restore.
	EarliestRestorableTime *time.Time `type:"timestamp"`

	// A list of log types that this cluster is configured to export to Amazon CloudWatch
	// Logs.
	EnabledCloudwatchLogsExports []*string `type:"list"`

	// Specifies the connection endpoint for the primary instance of the cluster.
	Endpoint *string `type:"string"`

	// Provides the name of the database engine to be used for this cluster.
	Engine *string `type:"string"`

	// Indicates the database engine version.
	EngineVersion *string `type:"string"`

	// Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
	HostedZoneId *string `type:"string"`

	// If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.
	KmsKeyId *string `type:"string"`

	// Specifies the latest time to which a database can be restored with point-in-time
	// restore.
	LatestRestorableTime *time.Time `type:"timestamp"`

	// Contains the master user name for the cluster.
	MasterUsername *string `type:"string"`

	// Specifies whether the cluster has instances in multiple Availability Zones.
	MultiAZ *bool `type:"boolean"`

	// Specifies the progress of the operation as a percentage.
	PercentProgress *string `type:"string"`

	// Specifies the port that the database engine is listening on.
	Port *int64 `type:"integer"`

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

	// Specifies the weekly time range during which system maintenance can occur,
	// in Universal Coordinated Time (UTC).
	PreferredMaintenanceWindow *string `type:"string"`

	// Contains one or more identifiers of the secondary clusters that are associated
	// with this cluster.
	ReadReplicaIdentifiers []*string `locationNameList:"ReadReplicaIdentifier" type:"list"`

	// The reader endpoint for the cluster. The reader endpoint for a cluster load
	// balances connections across the Amazon DocumentDB replicas that are available
	// in a cluster. As clients request new connections to the reader endpoint,
	// Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB
	// replicas in the cluster. This functionality can help balance your read workload
	// across multiple Amazon DocumentDB replicas in your cluster.
	//
	// If a failover occurs, and the Amazon DocumentDB replica that you are connected
	// to is promoted to be the primary instance, your connection is dropped. To
	// continue sending your read workload to other Amazon DocumentDB replicas in
	// the cluster, you can then reconnect to the reader endpoint.
	ReaderEndpoint *string `type:"string"`

	// Contains the identifier of the source cluster if this cluster is a secondary
	// cluster.
	ReplicationSourceIdentifier *string `type:"string"`

	// Specifies the current state of this cluster.
	Status *string `type:"string"`

	// Specifies whether the cluster is encrypted.
	StorageEncrypted *bool `type:"boolean"`

	// Storage type associated with your cluster
	//
	// Storage type associated with your cluster
	//
	// For information on storage types for Amazon DocumentDB clusters, see Cluster
	// storage configurations in the Amazon DocumentDB Developer Guide.
	//
	// Valid values for storage type - standard | iopt1
	//
	// Default value is standard
	StorageType *string `type:"string"`

	// Provides a list of virtual private cloud (VPC) security groups that the cluster
	// belongs to.
	VpcSecurityGroups []*VpcSecurityGroupMembership `locationNameList:"VpcSecurityGroupMembership" type:"list"`
	// contains filtered or unexported fields
}

Detailed information about a cluster.

func (DBCluster) GoString 

func (s DBCluster) 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 (*DBCluster) SetAssociatedRoles 

func (s *DBCluster) SetAssociatedRoles(v []*DBClusterRole) *DBCluster

SetAssociatedRoles sets the AssociatedRoles field's value.

func (*DBCluster) SetAvailabilityZones 

func (s *DBCluster) SetAvailabilityZones(v []*string) *DBCluster

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*DBCluster) SetBackupRetentionPeriod 

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*DBCluster) SetCloneGroupId added in v1.44.60 

func (s *DBCluster) SetCloneGroupId(v string) *DBCluster

SetCloneGroupId sets the CloneGroupId field's value.

func (*DBCluster) SetClusterCreateTime 

func (s *DBCluster) SetClusterCreateTime(v time.Time) *DBCluster

SetClusterCreateTime sets the ClusterCreateTime field's value.

func (*DBCluster) SetDBClusterArn 

func (s *DBCluster) SetDBClusterArn(v string) *DBCluster

SetDBClusterArn sets the DBClusterArn field's value.

func (*DBCluster) SetDBClusterIdentifier 

func (s *DBCluster) SetDBClusterIdentifier(v string) *DBCluster

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DBCluster) SetDBClusterMembers 

func (s *DBCluster) SetDBClusterMembers(v []*DBClusterMember) *DBCluster

SetDBClusterMembers sets the DBClusterMembers field's value.

func (*DBCluster) SetDBClusterParameterGroup 

func (s *DBCluster) SetDBClusterParameterGroup(v string) *DBCluster

SetDBClusterParameterGroup sets the DBClusterParameterGroup field's value.

func (*DBCluster) SetDBSubnetGroup 

func (s *DBCluster) SetDBSubnetGroup(v string) *DBCluster

SetDBSubnetGroup sets the DBSubnetGroup field's value.

func (*DBCluster) SetDbClusterResourceId 

func (s *DBCluster) SetDbClusterResourceId(v string) *DBCluster

SetDbClusterResourceId sets the DbClusterResourceId field's value.

func (*DBCluster) SetDeletionProtection added in v1.20.13 

func (s *DBCluster) SetDeletionProtection(v bool) *DBCluster

SetDeletionProtection sets the DeletionProtection field's value.

func (*DBCluster) SetEarliestRestorableTime 

func (s *DBCluster) SetEarliestRestorableTime(v time.Time) *DBCluster

SetEarliestRestorableTime sets the EarliestRestorableTime field's value.

func (*DBCluster) SetEnabledCloudwatchLogsExports 

func (s *DBCluster) SetEnabledCloudwatchLogsExports(v []*string) *DBCluster

SetEnabledCloudwatchLogsExports sets the EnabledCloudwatchLogsExports field's value.

func (*DBCluster) SetEndpoint 

func (s *DBCluster) SetEndpoint(v string) *DBCluster

SetEndpoint sets the Endpoint field's value.

func (*DBCluster) SetEngine 

func (s *DBCluster) SetEngine(v string) *DBCluster

SetEngine sets the Engine field's value.

func (*DBCluster) SetEngineVersion 

func (s *DBCluster) SetEngineVersion(v string) *DBCluster

SetEngineVersion sets the EngineVersion field's value.

func (*DBCluster) SetHostedZoneId 

func (s *DBCluster) SetHostedZoneId(v string) *DBCluster

SetHostedZoneId sets the HostedZoneId field's value.

func (*DBCluster) SetKmsKeyId 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*DBCluster) SetLatestRestorableTime 

func (s *DBCluster) SetLatestRestorableTime(v time.Time) *DBCluster

SetLatestRestorableTime sets the LatestRestorableTime field's value.

func (*DBCluster) SetMasterUsername 

func (s *DBCluster) SetMasterUsername(v string) *DBCluster

SetMasterUsername sets the MasterUsername field's value.

func (*DBCluster) SetMultiAZ 

func (s *DBCluster) SetMultiAZ(v bool) *DBCluster

SetMultiAZ sets the MultiAZ field's value.

func (*DBCluster) SetPercentProgress 

func (s *DBCluster) SetPercentProgress(v string) *DBCluster

SetPercentProgress sets the PercentProgress field's value.

func (*DBCluster) SetPort 

func (s *DBCluster) SetPort(v int64) *DBCluster

SetPort sets the Port field's value.

func (*DBCluster) SetPreferredBackupWindow 

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*DBCluster) SetPreferredMaintenanceWindow 

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*DBCluster) SetReadReplicaIdentifiers added in v1.38.53 

func (s *DBCluster) SetReadReplicaIdentifiers(v []*string) *DBCluster

SetReadReplicaIdentifiers sets the ReadReplicaIdentifiers field's value.

func (*DBCluster) SetReaderEndpoint 

func (s *DBCluster) SetReaderEndpoint(v string) *DBCluster

SetReaderEndpoint sets the ReaderEndpoint field's value.

func (*DBCluster) SetReplicationSourceIdentifier added in v1.38.53 

func (s *DBCluster) SetReplicationSourceIdentifier(v string) *DBCluster

SetReplicationSourceIdentifier sets the ReplicationSourceIdentifier field's value.

func (*DBCluster) SetStatus 

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

SetStatus sets the Status field's value.

func (*DBCluster) SetStorageEncrypted 

func (s *DBCluster) SetStorageEncrypted(v bool) *DBCluster

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*DBCluster) SetStorageType added in v1.48.1 

func (s *DBCluster) SetStorageType(v string) *DBCluster

SetStorageType sets the StorageType field's value.

func (*DBCluster) SetVpcSecurityGroups 

func (s *DBCluster) SetVpcSecurityGroups(v []*VpcSecurityGroupMembership) *DBCluster

SetVpcSecurityGroups sets the VpcSecurityGroups field's value.

func (DBCluster) String 

func (s DBCluster) 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 DBClusterMember 

type DBClusterMember struct {

	// Specifies the status of the cluster parameter group for this member of the
	// DB cluster.
	DBClusterParameterGroupStatus *string `type:"string"`

	// Specifies the instance identifier for this member of the cluster.
	DBInstanceIdentifier *string `type:"string"`

	// A value that is true if the cluster member is the primary instance for the
	// cluster and false otherwise.
	IsClusterWriter *bool `type:"boolean"`

	// A value that specifies the order in which an Amazon DocumentDB replica is
	// promoted to the primary instance after a failure of the existing primary
	// instance.
	PromotionTier *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Contains information about an instance that is part of a cluster.

func (DBClusterMember) GoString 

func (s DBClusterMember) 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 (*DBClusterMember) SetDBClusterParameterGroupStatus 

func (s *DBClusterMember) SetDBClusterParameterGroupStatus(v string) *DBClusterMember

SetDBClusterParameterGroupStatus sets the DBClusterParameterGroupStatus field's value.

func (*DBClusterMember) SetDBInstanceIdentifier 

func (s *DBClusterMember) SetDBInstanceIdentifier(v string) *DBClusterMember

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*DBClusterMember) SetIsClusterWriter 

func (s *DBClusterMember) SetIsClusterWriter(v bool) *DBClusterMember

SetIsClusterWriter sets the IsClusterWriter field's value.

func (*DBClusterMember) SetPromotionTier 

func (s *DBClusterMember) SetPromotionTier(v int64) *DBClusterMember

SetPromotionTier sets the PromotionTier field's value.

func (DBClusterMember) String 

func (s DBClusterMember) 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 DBClusterParameterGroup 

type DBClusterParameterGroup struct {

	// The Amazon Resource Name (ARN) for the cluster parameter group.
	DBClusterParameterGroupArn *string `type:"string"`

	// Provides the name of the cluster parameter group.
	DBClusterParameterGroupName *string `type:"string"`

	// Provides the name of the parameter group family that this cluster parameter
	// group is compatible with.
	DBParameterGroupFamily *string `type:"string"`

	// Provides the customer-specified description for this cluster parameter group.
	Description *string `type:"string"`
	// contains filtered or unexported fields
}

Detailed information about a cluster parameter group.

func (DBClusterParameterGroup) GoString 

func (s DBClusterParameterGroup) 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 (*DBClusterParameterGroup) SetDBClusterParameterGroupArn 

func (s *DBClusterParameterGroup) SetDBClusterParameterGroupArn(v string) *DBClusterParameterGroup

SetDBClusterParameterGroupArn sets the DBClusterParameterGroupArn field's value.

func (*DBClusterParameterGroup) SetDBClusterParameterGroupName 

func (s *DBClusterParameterGroup) SetDBClusterParameterGroupName(v string) *DBClusterParameterGroup

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*DBClusterParameterGroup) SetDBParameterGroupFamily 

func (s *DBClusterParameterGroup) SetDBParameterGroupFamily(v string) *DBClusterParameterGroup

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*DBClusterParameterGroup) SetDescription 

func (s *DBClusterParameterGroup) SetDescription(v string) *DBClusterParameterGroup

SetDescription sets the Description field's value.

func (DBClusterParameterGroup) String 

func (s DBClusterParameterGroup) 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 DBClusterRole 

type DBClusterRole struct {

	// The Amazon Resource Name (ARN) of the IAMrole that is associated with the
	// DB cluster.
	RoleArn *string `type:"string"`

	// Describes the state of association between the IAMrole and the cluster. The
	// Status property returns one of the following values:
	//
	//    * ACTIVE - The IAMrole ARN is associated with the cluster and can be used
	//    to access other Amazon Web Services services on your behalf.
	//
	//    * PENDING - The IAMrole ARN is being associated with the cluster.
	//
	//    * INVALID - The IAMrole ARN is associated with the cluster, but the cluster
	//    cannot assume the IAMrole to access other Amazon Web Services services
	//    on your behalf.
	Status *string `type:"string"`
	// contains filtered or unexported fields
}

Describes an Identity and Access Management (IAM) role that is associated with a cluster.

func (DBClusterRole) GoString 

func (s DBClusterRole) 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 (*DBClusterRole) SetRoleArn 

func (s *DBClusterRole) SetRoleArn(v string) *DBClusterRole

SetRoleArn sets the RoleArn field's value.

func (*DBClusterRole) SetStatus 

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

SetStatus sets the Status field's value.

func (DBClusterRole) String 

func (s DBClusterRole) 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 DBClusterSnapshot 

type DBClusterSnapshot struct {

	// Provides the list of Amazon EC2 Availability Zones that instances in the
	// cluster snapshot can be restored in.
	AvailabilityZones []*string `locationNameList:"AvailabilityZone" type:"list"`

	// Specifies the time when the cluster was created, in Universal Coordinated
	// Time (UTC).
	ClusterCreateTime *time.Time `type:"timestamp"`

	// Specifies the cluster identifier of the cluster that this cluster snapshot
	// was created from.
	DBClusterIdentifier *string `type:"string"`

	// The Amazon Resource Name (ARN) for the cluster snapshot.
	DBClusterSnapshotArn *string `type:"string"`

	// Specifies the identifier for the cluster snapshot.
	DBClusterSnapshotIdentifier *string `type:"string"`

	// Specifies the name of the database engine.
	Engine *string `type:"string"`

	// Provides the version of the database engine for this cluster snapshot.
	EngineVersion *string `type:"string"`

	// If StorageEncrypted is true, the KMS key identifier for the encrypted cluster
	// snapshot.
	KmsKeyId *string `type:"string"`

	// Provides the master user name for the cluster snapshot.
	MasterUsername *string `type:"string"`

	// Specifies the percentage of the estimated data that has been transferred.
	PercentProgress *int64 `type:"integer"`

	// Specifies the port that the cluster was listening on at the time of the snapshot.
	Port *int64 `type:"integer"`

	// Provides the time when the snapshot was taken, in UTC.
	SnapshotCreateTime *time.Time `type:"timestamp"`

	// Provides the type of the cluster snapshot.
	SnapshotType *string `type:"string"`

	// If the cluster snapshot was copied from a source cluster snapshot, the ARN
	// for the source cluster snapshot; otherwise, a null value.
	SourceDBClusterSnapshotArn *string `type:"string"`

	// Specifies the status of this cluster snapshot.
	Status *string `type:"string"`

	// Specifies whether the cluster snapshot is encrypted.
	StorageEncrypted *bool `type:"boolean"`

	// Storage type associated with your cluster snapshot
	//
	// For information on storage types for Amazon DocumentDB clusters, see Cluster
	// storage configurations in the Amazon DocumentDB Developer Guide.
	//
	// Valid values for storage type - standard | iopt1
	//
	// Default value is standard
	StorageType *string `type:"string"`

	// Provides the virtual private cloud (VPC) ID that is associated with the cluster
	// snapshot.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Detailed information about a cluster snapshot.

func (DBClusterSnapshot) GoString 

func (s DBClusterSnapshot) 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 (*DBClusterSnapshot) SetAvailabilityZones 

func (s *DBClusterSnapshot) SetAvailabilityZones(v []*string) *DBClusterSnapshot

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*DBClusterSnapshot) SetClusterCreateTime 

func (s *DBClusterSnapshot) SetClusterCreateTime(v time.Time) *DBClusterSnapshot

SetClusterCreateTime sets the ClusterCreateTime field's value.

func (*DBClusterSnapshot) SetDBClusterIdentifier 

func (s *DBClusterSnapshot) SetDBClusterIdentifier(v string) *DBClusterSnapshot

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DBClusterSnapshot) SetDBClusterSnapshotArn 

func (s *DBClusterSnapshot) SetDBClusterSnapshotArn(v string) *DBClusterSnapshot

SetDBClusterSnapshotArn sets the DBClusterSnapshotArn field's value.

func (*DBClusterSnapshot) SetDBClusterSnapshotIdentifier 

func (s *DBClusterSnapshot) SetDBClusterSnapshotIdentifier(v string) *DBClusterSnapshot

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (*DBClusterSnapshot) SetEngine 

func (s *DBClusterSnapshot) SetEngine(v string) *DBClusterSnapshot

SetEngine sets the Engine field's value.

func (*DBClusterSnapshot) SetEngineVersion 

func (s *DBClusterSnapshot) SetEngineVersion(v string) *DBClusterSnapshot

SetEngineVersion sets the EngineVersion field's value.

func (*DBClusterSnapshot) SetKmsKeyId 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*DBClusterSnapshot) SetMasterUsername 

func (s *DBClusterSnapshot) SetMasterUsername(v string) *DBClusterSnapshot

SetMasterUsername sets the MasterUsername field's value.

func (*DBClusterSnapshot) SetPercentProgress 

func (s *DBClusterSnapshot) SetPercentProgress(v int64) *DBClusterSnapshot

SetPercentProgress sets the PercentProgress field's value.

func (*DBClusterSnapshot) SetPort 

func (s *DBClusterSnapshot) SetPort(v int64) *DBClusterSnapshot

SetPort sets the Port field's value.

func (*DBClusterSnapshot) SetSnapshotCreateTime 

func (s *DBClusterSnapshot) SetSnapshotCreateTime(v time.Time) *DBClusterSnapshot

SetSnapshotCreateTime sets the SnapshotCreateTime field's value.

func (*DBClusterSnapshot) SetSnapshotType 

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

SetSnapshotType sets the SnapshotType field's value.

func (*DBClusterSnapshot) SetSourceDBClusterSnapshotArn 

func (s *DBClusterSnapshot) SetSourceDBClusterSnapshotArn(v string) *DBClusterSnapshot

SetSourceDBClusterSnapshotArn sets the SourceDBClusterSnapshotArn field's value.

func (*DBClusterSnapshot) SetStatus 

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

SetStatus sets the Status field's value.

func (*DBClusterSnapshot) SetStorageEncrypted 

func (s *DBClusterSnapshot) SetStorageEncrypted(v bool) *DBClusterSnapshot

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*DBClusterSnapshot) SetStorageType added in v1.48.1 

func (s *DBClusterSnapshot) SetStorageType(v string) *DBClusterSnapshot

SetStorageType sets the StorageType field's value.

func (*DBClusterSnapshot) SetVpcId 

func (s *DBClusterSnapshot) SetVpcId(v string) *DBClusterSnapshot

SetVpcId sets the VpcId field's value.

func (DBClusterSnapshot) String 

func (s DBClusterSnapshot) 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 DBClusterSnapshotAttribute 

type DBClusterSnapshotAttribute struct {

	// The name of the manual cluster snapshot attribute.
	//
	// The attribute named restore refers to the list of Amazon Web Services accounts
	// that have permission to copy or restore the manual cluster snapshot.
	AttributeName *string `type:"string"`

	// The values for the manual cluster snapshot attribute.
	//
	// If the AttributeName field is set to restore, then this element returns a
	// list of IDs of the Amazon Web Services accounts that are authorized to copy
	// or restore the manual cluster snapshot. If a value of all is in the list,
	// then the manual cluster snapshot is public and available for any Amazon Web
	// Services account to copy or restore.
	AttributeValues []*string `locationNameList:"AttributeValue" type:"list"`
	// contains filtered or unexported fields
}

Contains the name and values of a manual cluster snapshot attribute.

Manual cluster snapshot attributes are used to authorize other Amazon Web Services accounts to restore a manual cluster snapshot.

func (DBClusterSnapshotAttribute) GoString 

func (s DBClusterSnapshotAttribute) 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 (*DBClusterSnapshotAttribute) SetAttributeName 

func (s *DBClusterSnapshotAttribute) SetAttributeName(v string) *DBClusterSnapshotAttribute

SetAttributeName sets the AttributeName field's value.

func (*DBClusterSnapshotAttribute) SetAttributeValues 

func (s *DBClusterSnapshotAttribute) SetAttributeValues(v []*string) *DBClusterSnapshotAttribute

SetAttributeValues sets the AttributeValues field's value.

func (DBClusterSnapshotAttribute) String 

func (s DBClusterSnapshotAttribute) 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 DBClusterSnapshotAttributesResult 

type DBClusterSnapshotAttributesResult struct {

	// The list of attributes and values for the cluster snapshot.
	DBClusterSnapshotAttributes []*DBClusterSnapshotAttribute `locationNameList:"DBClusterSnapshotAttribute" type:"list"`

	// The identifier of the cluster snapshot that the attributes apply to.
	DBClusterSnapshotIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

Detailed information about the attributes that are associated with a cluster snapshot.

func (DBClusterSnapshotAttributesResult) GoString 

func (s DBClusterSnapshotAttributesResult) 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 (*DBClusterSnapshotAttributesResult) SetDBClusterSnapshotAttributes 

func (s *DBClusterSnapshotAttributesResult) SetDBClusterSnapshotAttributes(v []*DBClusterSnapshotAttribute) *DBClusterSnapshotAttributesResult

SetDBClusterSnapshotAttributes sets the DBClusterSnapshotAttributes field's value.

func (*DBClusterSnapshotAttributesResult) SetDBClusterSnapshotIdentifier 

func (s *DBClusterSnapshotAttributesResult) SetDBClusterSnapshotIdentifier(v string) *DBClusterSnapshotAttributesResult

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (DBClusterSnapshotAttributesResult) String 

func (s DBClusterSnapshotAttributesResult) 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 DBEngineVersion 

type DBEngineVersion struct {

	// The description of the database engine.
	DBEngineDescription *string `type:"string"`

	// The description of the database engine version.
	DBEngineVersionDescription *string `type:"string"`

	// The name of the parameter group family for the database engine.
	DBParameterGroupFamily *string `type:"string"`

	// The name of the database engine.
	Engine *string `type:"string"`

	// The version number of the database engine.
	EngineVersion *string `type:"string"`

	// The types of logs that the database engine has available for export to Amazon
	// CloudWatch Logs.
	ExportableLogTypes []*string `type:"list"`

	// A list of the supported CA certificate identifiers.
	//
	// For more information, see Updating Your Amazon DocumentDB TLS Certificates
	// (https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html)
	// and Encrypting Data in Transit (https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)
	// in the Amazon DocumentDB Developer Guide.
	SupportedCACertificateIdentifiers []*string `type:"list"`

	// Indicates whether the engine version supports rotating the server certificate
	// without rebooting the DB instance.
	SupportsCertificateRotationWithoutRestart *bool `type:"boolean"`

	// A value that indicates whether the engine version supports exporting the
	// log types specified by ExportableLogTypes to CloudWatch Logs.
	SupportsLogExportsToCloudwatchLogs *bool `type:"boolean"`

	// A list of engine versions that this database engine version can be upgraded
	// to.
	ValidUpgradeTarget []*UpgradeTarget `locationNameList:"UpgradeTarget" type:"list"`
	// contains filtered or unexported fields
}

Detailed information about an engine version.

func (DBEngineVersion) GoString 

func (s DBEngineVersion) 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 (*DBEngineVersion) SetDBEngineDescription 

func (s *DBEngineVersion) SetDBEngineDescription(v string) *DBEngineVersion

SetDBEngineDescription sets the DBEngineDescription field's value.

func (*DBEngineVersion) SetDBEngineVersionDescription 

func (s *DBEngineVersion) SetDBEngineVersionDescription(v string) *DBEngineVersion

SetDBEngineVersionDescription sets the DBEngineVersionDescription field's value.

func (*DBEngineVersion) SetDBParameterGroupFamily 

func (s *DBEngineVersion) SetDBParameterGroupFamily(v string) *DBEngineVersion

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*DBEngineVersion) SetEngine 

func (s *DBEngineVersion) SetEngine(v string) *DBEngineVersion

SetEngine sets the Engine field's value.

func (*DBEngineVersion) SetEngineVersion 

func (s *DBEngineVersion) SetEngineVersion(v string) *DBEngineVersion

SetEngineVersion sets the EngineVersion field's value.

func (*DBEngineVersion) SetExportableLogTypes 

func (s *DBEngineVersion) SetExportableLogTypes(v []*string) *DBEngineVersion

SetExportableLogTypes sets the ExportableLogTypes field's value.

func (*DBEngineVersion) SetSupportedCACertificateIdentifiers added in v1.47.4 

func (s *DBEngineVersion) SetSupportedCACertificateIdentifiers(v []*string) *DBEngineVersion

SetSupportedCACertificateIdentifiers sets the SupportedCACertificateIdentifiers field's value.

func (*DBEngineVersion) SetSupportsCertificateRotationWithoutRestart added in v1.47.4 

func (s *DBEngineVersion) SetSupportsCertificateRotationWithoutRestart(v bool) *DBEngineVersion

SetSupportsCertificateRotationWithoutRestart sets the SupportsCertificateRotationWithoutRestart field's value.

func (*DBEngineVersion) SetSupportsLogExportsToCloudwatchLogs 

func (s *DBEngineVersion) SetSupportsLogExportsToCloudwatchLogs(v bool) *DBEngineVersion

SetSupportsLogExportsToCloudwatchLogs sets the SupportsLogExportsToCloudwatchLogs field's value.

func (*DBEngineVersion) SetValidUpgradeTarget 

func (s *DBEngineVersion) SetValidUpgradeTarget(v []*UpgradeTarget) *DBEngineVersion

SetValidUpgradeTarget sets the ValidUpgradeTarget field's value.

func (DBEngineVersion) String 

func (s DBEngineVersion) 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 DBInstance 

type DBInstance struct {

	// Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon
	// DocumentDB does not perform minor version upgrades regardless of the value
	// set.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// Specifies the name of the Availability Zone that the instance is located
	// in.
	AvailabilityZone *string `type:"string"`

	// Specifies the number of days for which automatic snapshots are retained.
	BackupRetentionPeriod *int64 `type:"integer"`

	// The identifier of the CA certificate for this DB instance.
	CACertificateIdentifier *string `type:"string"`

	// The details of the DB instance's server certificate.
	CertificateDetails *CertificateDetails `type:"structure"`

	// A value that indicates whether to copy tags from the DB instance to snapshots
	// of the DB instance. By default, tags are not copied.
	CopyTagsToSnapshot *bool `type:"boolean"`

	// Contains the name of the cluster that the instance is a member of if the
	// instance is a member of a cluster.
	DBClusterIdentifier *string `type:"string"`

	// The Amazon Resource Name (ARN) for the instance.
	DBInstanceArn *string `type:"string"`

	// Contains the name of the compute and memory capacity class of the instance.
	DBInstanceClass *string `type:"string"`

	// Contains a user-provided database identifier. This identifier is the unique
	// key that identifies an instance.
	DBInstanceIdentifier *string `type:"string"`

	// Specifies the current state of this database.
	DBInstanceStatus *string `type:"string"`

	// Specifies information on the subnet group that is associated with the instance,
	// including the name, description, and subnets in the subnet group.
	DBSubnetGroup *DBSubnetGroup `type:"structure"`

	// The Amazon Web Services Region-unique, immutable identifier for the instance.
	// This identifier is found in CloudTrail log entries whenever the KMS key for
	// the instance is accessed.
	DbiResourceId *string `type:"string"`

	// A list of log types that this instance is configured to export to CloudWatch
	// Logs.
	EnabledCloudwatchLogsExports []*string `type:"list"`

	// Specifies the connection endpoint.
	Endpoint *Endpoint `type:"structure"`

	// Provides the name of the database engine to be used for this instance.
	Engine *string `type:"string"`

	// Indicates the database engine version.
	EngineVersion *string `type:"string"`

	// Provides the date and time that the instance was created.
	InstanceCreateTime *time.Time `type:"timestamp"`

	// If StorageEncrypted is true, the KMS key identifier for the encrypted instance.
	KmsKeyId *string `type:"string"`

	// Specifies the latest time to which a database can be restored with point-in-time
	// restore.
	LatestRestorableTime *time.Time `type:"timestamp"`

	// Specifies that changes to the instance are pending. This element is included
	// only when changes are pending. Specific changes are identified by subelements.
	PendingModifiedValues *PendingModifiedValues `type:"structure"`

	// Set to true if Amazon RDS Performance Insights is enabled for the DB instance,
	// and otherwise false.
	PerformanceInsightsEnabled *bool `type:"boolean"`

	// The KMS key identifier for encryption of Performance Insights data. The KMS
	// key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS
	// key alias for the KMS encryption key.
	PerformanceInsightsKMSKeyId *string `type:"string"`

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

	// Specifies the weekly time range during which system maintenance can occur,
	// in Universal Coordinated Time (UTC).
	PreferredMaintenanceWindow *string `type:"string"`

	// A value that specifies the order in which an Amazon DocumentDB replica is
	// promoted to the primary instance after a failure of the existing primary
	// instance.
	PromotionTier *int64 `type:"integer"`

	// Not supported. Amazon DocumentDB does not currently support public endpoints.
	// The value of PubliclyAccessible is always false.
	PubliclyAccessible *bool `type:"boolean"`

	// The status of a read replica. If the instance is not a read replica, this
	// is blank.
	StatusInfos []*DBInstanceStatusInfo `locationNameList:"DBInstanceStatusInfo" type:"list"`

	// Specifies whether or not the instance is encrypted.
	StorageEncrypted *bool `type:"boolean"`

	// Provides a list of VPC security group elements that the instance belongs
	// to.
	VpcSecurityGroups []*VpcSecurityGroupMembership `locationNameList:"VpcSecurityGroupMembership" type:"list"`
	// contains filtered or unexported fields
}

Detailed information about an instance.

func (DBInstance) GoString 

func (s DBInstance) 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 (*DBInstance) SetAutoMinorVersionUpgrade 

func (s *DBInstance) SetAutoMinorVersionUpgrade(v bool) *DBInstance

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*DBInstance) SetAvailabilityZone 

func (s *DBInstance) SetAvailabilityZone(v string) *DBInstance

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*DBInstance) SetBackupRetentionPeriod 

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*DBInstance) SetCACertificateIdentifier added in v1.25.3 

func (s *DBInstance) SetCACertificateIdentifier(v string) *DBInstance

SetCACertificateIdentifier sets the CACertificateIdentifier field's value.

func (*DBInstance) SetCertificateDetails added in v1.47.4 

func (s *DBInstance) SetCertificateDetails(v *CertificateDetails) *DBInstance

SetCertificateDetails sets the CertificateDetails field's value.

func (*DBInstance) SetCopyTagsToSnapshot added in v1.44.60 

func (s *DBInstance) SetCopyTagsToSnapshot(v bool) *DBInstance

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*DBInstance) SetDBClusterIdentifier 

func (s *DBInstance) SetDBClusterIdentifier(v string) *DBInstance

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DBInstance) SetDBInstanceArn 

func (s *DBInstance) SetDBInstanceArn(v string) *DBInstance

SetDBInstanceArn sets the DBInstanceArn field's value.

func (*DBInstance) SetDBInstanceClass 

func (s *DBInstance) SetDBInstanceClass(v string) *DBInstance

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*DBInstance) SetDBInstanceIdentifier 

func (s *DBInstance) SetDBInstanceIdentifier(v string) *DBInstance

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*DBInstance) SetDBInstanceStatus 

func (s *DBInstance) SetDBInstanceStatus(v string) *DBInstance

SetDBInstanceStatus sets the DBInstanceStatus field's value.

func (*DBInstance) SetDBSubnetGroup 

func (s *DBInstance) SetDBSubnetGroup(v *DBSubnetGroup) *DBInstance

SetDBSubnetGroup sets the DBSubnetGroup field's value.

func (*DBInstance) SetDbiResourceId 

func (s *DBInstance) SetDbiResourceId(v string) *DBInstance

SetDbiResourceId sets the DbiResourceId field's value.

func (*DBInstance) SetEnabledCloudwatchLogsExports 

func (s *DBInstance) SetEnabledCloudwatchLogsExports(v []*string) *DBInstance

SetEnabledCloudwatchLogsExports sets the EnabledCloudwatchLogsExports field's value.

func (*DBInstance) SetEndpoint 

func (s *DBInstance) SetEndpoint(v *Endpoint) *DBInstance

SetEndpoint sets the Endpoint field's value.

func (*DBInstance) SetEngine 

func (s *DBInstance) SetEngine(v string) *DBInstance

SetEngine sets the Engine field's value.

func (*DBInstance) SetEngineVersion 

func (s *DBInstance) SetEngineVersion(v string) *DBInstance

SetEngineVersion sets the EngineVersion field's value.

func (*DBInstance) SetInstanceCreateTime 

func (s *DBInstance) SetInstanceCreateTime(v time.Time) *DBInstance

SetInstanceCreateTime sets the InstanceCreateTime field's value.

func (*DBInstance) SetKmsKeyId 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*DBInstance) SetLatestRestorableTime 

func (s *DBInstance) SetLatestRestorableTime(v time.Time) *DBInstance

SetLatestRestorableTime sets the LatestRestorableTime field's value.

func (*DBInstance) SetPendingModifiedValues 

func (s *DBInstance) SetPendingModifiedValues(v *PendingModifiedValues) *DBInstance

SetPendingModifiedValues sets the PendingModifiedValues field's value.

func (*DBInstance) SetPerformanceInsightsEnabled added in v1.49.15 

func (s *DBInstance) SetPerformanceInsightsEnabled(v bool) *DBInstance

SetPerformanceInsightsEnabled sets the PerformanceInsightsEnabled field's value.

func (*DBInstance) SetPerformanceInsightsKMSKeyId added in v1.49.15 

func (s *DBInstance) SetPerformanceInsightsKMSKeyId(v string) *DBInstance

SetPerformanceInsightsKMSKeyId sets the PerformanceInsightsKMSKeyId field's value.

func (*DBInstance) SetPreferredBackupWindow 

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*DBInstance) SetPreferredMaintenanceWindow 

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*DBInstance) SetPromotionTier 

func (s *DBInstance) SetPromotionTier(v int64) *DBInstance

SetPromotionTier sets the PromotionTier field's value.

func (*DBInstance) SetPubliclyAccessible 

func (s *DBInstance) SetPubliclyAccessible(v bool) *DBInstance

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*DBInstance) SetStatusInfos 

func (s *DBInstance) SetStatusInfos(v []*DBInstanceStatusInfo) *DBInstance

SetStatusInfos sets the StatusInfos field's value.

func (*DBInstance) SetStorageEncrypted 

func (s *DBInstance) SetStorageEncrypted(v bool) *DBInstance

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*DBInstance) SetVpcSecurityGroups 

func (s *DBInstance) SetVpcSecurityGroups(v []*VpcSecurityGroupMembership) *DBInstance

SetVpcSecurityGroups sets the VpcSecurityGroups field's value.

func (DBInstance) String 

func (s DBInstance) 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 DBInstanceStatusInfo 

type DBInstanceStatusInfo struct {

	// Details of the error if there is an error for the instance. If the instance
	// is not in an error state, this value is blank.
	Message *string `type:"string"`

	// A Boolean value that is true if the instance is operating normally, or false
	// if the instance is in an error state.
	Normal *bool `type:"boolean"`

	// Status of the instance. For a StatusType of read replica, the values can
	// be replicating, error, stopped, or terminated.
	Status *string `type:"string"`

	// This value is currently "read replication."
	StatusType *string `type:"string"`
	// contains filtered or unexported fields
}

Provides a list of status information for an instance.

func (DBInstanceStatusInfo) GoString 

func (s DBInstanceStatusInfo) 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 (*DBInstanceStatusInfo) SetMessage 

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

SetMessage sets the Message field's value.

func (*DBInstanceStatusInfo) SetNormal 

func (s *DBInstanceStatusInfo) SetNormal(v bool) *DBInstanceStatusInfo

SetNormal sets the Normal field's value.

func (*DBInstanceStatusInfo) SetStatus 

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

SetStatus sets the Status field's value.

func (*DBInstanceStatusInfo) SetStatusType 

func (s *DBInstanceStatusInfo) SetStatusType(v string) *DBInstanceStatusInfo

SetStatusType sets the StatusType field's value.

func (DBInstanceStatusInfo) String 

func (s DBInstanceStatusInfo) 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 DBSubnetGroup 

type DBSubnetGroup struct {

	// The Amazon Resource Name (ARN) for the DB subnet group.
	DBSubnetGroupArn *string `type:"string"`

	// Provides the description of the subnet group.
	DBSubnetGroupDescription *string `type:"string"`

	// The name of the subnet group.
	DBSubnetGroupName *string `type:"string"`

	// Provides the status of the subnet group.
	SubnetGroupStatus *string `type:"string"`

	// Detailed information about one or more subnets within a subnet group.
	Subnets []*Subnet `locationNameList:"Subnet" type:"list"`

	// Provides the virtual private cloud (VPC) ID of the subnet group.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Detailed information about a subnet group.

func (DBSubnetGroup) GoString 

func (s DBSubnetGroup) 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 (*DBSubnetGroup) SetDBSubnetGroupArn 

func (s *DBSubnetGroup) SetDBSubnetGroupArn(v string) *DBSubnetGroup

SetDBSubnetGroupArn sets the DBSubnetGroupArn field's value.

func (*DBSubnetGroup) SetDBSubnetGroupDescription 

func (s *DBSubnetGroup) SetDBSubnetGroupDescription(v string) *DBSubnetGroup

SetDBSubnetGroupDescription sets the DBSubnetGroupDescription field's value.

func (*DBSubnetGroup) SetDBSubnetGroupName 

func (s *DBSubnetGroup) SetDBSubnetGroupName(v string) *DBSubnetGroup

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*DBSubnetGroup) SetSubnetGroupStatus 

func (s *DBSubnetGroup) SetSubnetGroupStatus(v string) *DBSubnetGroup

SetSubnetGroupStatus sets the SubnetGroupStatus field's value.

func (*DBSubnetGroup) SetSubnets 

func (s *DBSubnetGroup) SetSubnets(v []*Subnet) *DBSubnetGroup

SetSubnets sets the Subnets field's value.

func (*DBSubnetGroup) SetVpcId 

func (s *DBSubnetGroup) SetVpcId(v string) *DBSubnetGroup

SetVpcId sets the VpcId field's value.

func (DBSubnetGroup) String 

func (s DBSubnetGroup) 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 DeleteDBClusterInput 

type DeleteDBClusterInput struct {

	// The cluster identifier for the cluster to be deleted. This parameter isn't
	// case sensitive.
	//
	// Constraints:
	//
	//    * Must match an existing DBClusterIdentifier.
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The cluster snapshot identifier of the new cluster snapshot created when
	// SkipFinalSnapshot is set to false.
	//
	// Specifying this parameter and also setting the SkipFinalShapshot parameter
	// to true results in an error.
	//
	// Constraints:
	//
	//    * Must be from 1 to 255 letters, numbers, or hyphens.
	//
	//    * The first character must be a letter.
	//
	//    * Cannot end with a hyphen or contain two consecutive hyphens.
	FinalDBSnapshotIdentifier *string `type:"string"`

	// Determines whether a final cluster snapshot is created before the cluster
	// is deleted. If true is specified, no cluster snapshot is created. If false
	// is specified, a cluster snapshot is created before the DB cluster is deleted.
	//
	// If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier
	// parameter.
	//
	// Default: false
	SkipFinalSnapshot *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Represents the input to DeleteDBCluster.

func (DeleteDBClusterInput) GoString 

func (s DeleteDBClusterInput) 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 (*DeleteDBClusterInput) SetDBClusterIdentifier 

func (s *DeleteDBClusterInput) SetDBClusterIdentifier(v string) *DeleteDBClusterInput

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DeleteDBClusterInput) SetFinalDBSnapshotIdentifier 

func (s *DeleteDBClusterInput) SetFinalDBSnapshotIdentifier(v string) *DeleteDBClusterInput

SetFinalDBSnapshotIdentifier sets the FinalDBSnapshotIdentifier field's value.

func (*DeleteDBClusterInput) SetSkipFinalSnapshot 

func (s *DeleteDBClusterInput) SetSkipFinalSnapshot(v bool) *DeleteDBClusterInput

SetSkipFinalSnapshot sets the SkipFinalSnapshot field's value.

func (DeleteDBClusterInput) String 

func (s DeleteDBClusterInput) 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 (*DeleteDBClusterInput) Validate 

func (s *DeleteDBClusterInput) Validate() error

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

type DeleteDBClusterOutput 

type DeleteDBClusterOutput struct {

	// Detailed information about a cluster.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteDBClusterOutput) GoString 

func (s DeleteDBClusterOutput) 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 (*DeleteDBClusterOutput) SetDBCluster 

func (s *DeleteDBClusterOutput) SetDBCluster(v *DBCluster) *DeleteDBClusterOutput

SetDBCluster sets the DBCluster field's value.

func (DeleteDBClusterOutput) String 

func (s DeleteDBClusterOutput) 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 DeleteDBClusterParameterGroupInput 

type DeleteDBClusterParameterGroupInput struct {

	// The name of the cluster parameter group.
	//
	// Constraints:
	//
	//    * Must be the name of an existing cluster parameter group.
	//
	//    * You can't delete a default cluster parameter group.
	//
	//    * Cannot be associated with any clusters.
	//
	// DBClusterParameterGroupName is a required field
	DBClusterParameterGroupName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to DeleteDBClusterParameterGroup.

func (DeleteDBClusterParameterGroupInput) GoString 

func (s DeleteDBClusterParameterGroupInput) 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 (*DeleteDBClusterParameterGroupInput) SetDBClusterParameterGroupName 

func (s *DeleteDBClusterParameterGroupInput) SetDBClusterParameterGroupName(v string) *DeleteDBClusterParameterGroupInput

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (DeleteDBClusterParameterGroupInput) String 

func (s DeleteDBClusterParameterGroupInput) 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 (*DeleteDBClusterParameterGroupInput) Validate 

func (s *DeleteDBClusterParameterGroupInput) Validate() error

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

type DeleteDBClusterParameterGroupOutput 

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

func (DeleteDBClusterParameterGroupOutput) GoString 

func (s DeleteDBClusterParameterGroupOutput) 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 (DeleteDBClusterParameterGroupOutput) String 

func (s DeleteDBClusterParameterGroupOutput) 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 DeleteDBClusterSnapshotInput 

type DeleteDBClusterSnapshotInput struct {

	// The identifier of the cluster snapshot to delete.
	//
	// Constraints: Must be the name of an existing cluster snapshot in the available
	// state.
	//
	// DBClusterSnapshotIdentifier is a required field
	DBClusterSnapshotIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to DeleteDBClusterSnapshot.

func (DeleteDBClusterSnapshotInput) GoString 

func (s DeleteDBClusterSnapshotInput) 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 (*DeleteDBClusterSnapshotInput) SetDBClusterSnapshotIdentifier 

func (s *DeleteDBClusterSnapshotInput) SetDBClusterSnapshotIdentifier(v string) *DeleteDBClusterSnapshotInput

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (DeleteDBClusterSnapshotInput) String 

func (s DeleteDBClusterSnapshotInput) 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 (*DeleteDBClusterSnapshotInput) Validate 

func (s *DeleteDBClusterSnapshotInput) Validate() error

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

type DeleteDBClusterSnapshotOutput 

type DeleteDBClusterSnapshotOutput struct {

	// Detailed information about a cluster snapshot.
	DBClusterSnapshot *DBClusterSnapshot `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteDBClusterSnapshotOutput) GoString 

func (s DeleteDBClusterSnapshotOutput) 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 (*DeleteDBClusterSnapshotOutput) SetDBClusterSnapshot 

func (s *DeleteDBClusterSnapshotOutput) SetDBClusterSnapshot(v *DBClusterSnapshot) *DeleteDBClusterSnapshotOutput

SetDBClusterSnapshot sets the DBClusterSnapshot field's value.

func (DeleteDBClusterSnapshotOutput) String 

func (s DeleteDBClusterSnapshotOutput) 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 DeleteDBInstanceInput 

type DeleteDBInstanceInput struct {

	// The instance identifier for the instance to be deleted. This parameter isn't
	// case sensitive.
	//
	// Constraints:
	//
	//    * Must match the name of an existing instance.
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to DeleteDBInstance.

func (DeleteDBInstanceInput) GoString 

func (s DeleteDBInstanceInput) 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 (*DeleteDBInstanceInput) SetDBInstanceIdentifier 

func (s *DeleteDBInstanceInput) SetDBInstanceIdentifier(v string) *DeleteDBInstanceInput

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (DeleteDBInstanceInput) String 

func (s DeleteDBInstanceInput) 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 (*DeleteDBInstanceInput) Validate 

func (s *DeleteDBInstanceInput) Validate() error

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

type DeleteDBInstanceOutput 

type DeleteDBInstanceOutput struct {

	// Detailed information about an instance.
	DBInstance *DBInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteDBInstanceOutput) GoString 

func (s DeleteDBInstanceOutput) 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 (*DeleteDBInstanceOutput) SetDBInstance 

func (s *DeleteDBInstanceOutput) SetDBInstance(v *DBInstance) *DeleteDBInstanceOutput

SetDBInstance sets the DBInstance field's value.

func (DeleteDBInstanceOutput) String 

func (s DeleteDBInstanceOutput) 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 DeleteDBSubnetGroupInput 

type DeleteDBSubnetGroupInput struct {

	// The name of the database subnet group to delete.
	//
	// You can't delete the default subnet group.
	//
	// Constraints:
	//
	// Must match the name of an existing DBSubnetGroup. Must not be default.
	//
	// Example: mySubnetgroup
	//
	// DBSubnetGroupName is a required field
	DBSubnetGroupName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to DeleteDBSubnetGroup.

func (DeleteDBSubnetGroupInput) GoString 

func (s DeleteDBSubnetGroupInput) 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 (*DeleteDBSubnetGroupInput) SetDBSubnetGroupName 

func (s *DeleteDBSubnetGroupInput) SetDBSubnetGroupName(v string) *DeleteDBSubnetGroupInput

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (DeleteDBSubnetGroupInput) String 

func (s DeleteDBSubnetGroupInput) 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 (*DeleteDBSubnetGroupInput) Validate 

func (s *DeleteDBSubnetGroupInput) Validate() error

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

type DeleteDBSubnetGroupOutput 

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

func (DeleteDBSubnetGroupOutput) GoString 

func (s DeleteDBSubnetGroupOutput) 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 (DeleteDBSubnetGroupOutput) String 

func (s DeleteDBSubnetGroupOutput) 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 DeleteEventSubscriptionInput added in v1.38.8 

type DeleteEventSubscriptionInput struct {

	// The name of the Amazon DocumentDB event notification subscription that you
	// want to delete.
	//
	// SubscriptionName is a required field
	SubscriptionName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to DeleteEventSubscription.

func (DeleteEventSubscriptionInput) GoString added in v1.38.8 

func (s DeleteEventSubscriptionInput) 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 (*DeleteEventSubscriptionInput) SetSubscriptionName added in v1.38.8 

func (s *DeleteEventSubscriptionInput) SetSubscriptionName(v string) *DeleteEventSubscriptionInput

SetSubscriptionName sets the SubscriptionName field's value.

func (DeleteEventSubscriptionInput) String added in v1.38.8 

func (s DeleteEventSubscriptionInput) 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 (*DeleteEventSubscriptionInput) Validate added in v1.38.8 

func (s *DeleteEventSubscriptionInput) Validate() error

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

type DeleteEventSubscriptionOutput added in v1.38.8 

type DeleteEventSubscriptionOutput struct {

	// Detailed information about an event to which you have subscribed.
	EventSubscription *EventSubscription `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteEventSubscriptionOutput) GoString added in v1.38.8 

func (s DeleteEventSubscriptionOutput) 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 (*DeleteEventSubscriptionOutput) SetEventSubscription added in v1.38.8 

func (s *DeleteEventSubscriptionOutput) SetEventSubscription(v *EventSubscription) *DeleteEventSubscriptionOutput

SetEventSubscription sets the EventSubscription field's value.

func (DeleteEventSubscriptionOutput) String added in v1.38.8 

func (s DeleteEventSubscriptionOutput) 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 DeleteGlobalClusterInput added in v1.38.53 

type DeleteGlobalClusterInput struct {

	// The cluster identifier of the global cluster being deleted.
	//
	// GlobalClusterIdentifier is a required field
	GlobalClusterIdentifier *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to DeleteGlobalCluster.

func (DeleteGlobalClusterInput) GoString added in v1.38.53 

func (s DeleteGlobalClusterInput) 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 (*DeleteGlobalClusterInput) SetGlobalClusterIdentifier added in v1.38.53 

func (s *DeleteGlobalClusterInput) SetGlobalClusterIdentifier(v string) *DeleteGlobalClusterInput

SetGlobalClusterIdentifier sets the GlobalClusterIdentifier field's value.

func (DeleteGlobalClusterInput) String added in v1.38.53 

func (s DeleteGlobalClusterInput) 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 (*DeleteGlobalClusterInput) Validate added in v1.38.53 

func (s *DeleteGlobalClusterInput) Validate() error

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

type DeleteGlobalClusterOutput added in v1.38.53 

type DeleteGlobalClusterOutput struct {

	// A data type representing an Amazon DocumentDB global cluster.
	GlobalCluster *GlobalCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteGlobalClusterOutput) GoString added in v1.38.53 

func (s DeleteGlobalClusterOutput) 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 (*DeleteGlobalClusterOutput) SetGlobalCluster added in v1.38.53 

func (s *DeleteGlobalClusterOutput) SetGlobalCluster(v *GlobalCluster) *DeleteGlobalClusterOutput

SetGlobalCluster sets the GlobalCluster field's value.

func (DeleteGlobalClusterOutput) String added in v1.38.53 

func (s DeleteGlobalClusterOutput) 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 DescribeCertificatesInput added in v1.25.3 

type DescribeCertificatesInput struct {

	// The user-supplied certificate identifier. If this parameter is specified,
	// information for only the specified certificate is returned. If this parameter
	// is omitted, a list of up to MaxRecords certificates is returned. This parameter
	// is not case sensitive.
	//
	// Constraints
	//
	//    * Must match an existing CertificateIdentifier.
	CertificateIdentifier *string `type:"string"`

	// This parameter is not currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous DescribeCertificates
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints:
	//
	//    * Minimum: 20
	//
	//    * Maximum: 100
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeCertificatesInput) GoString added in v1.25.3 

func (s DescribeCertificatesInput) 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 (*DescribeCertificatesInput) SetCertificateIdentifier added in v1.25.3 

func (s *DescribeCertificatesInput) SetCertificateIdentifier(v string) *DescribeCertificatesInput

SetCertificateIdentifier sets the CertificateIdentifier field's value.

func (*DescribeCertificatesInput) SetFilters added in v1.25.3 

func (s *DescribeCertificatesInput) SetFilters(v []*Filter) *DescribeCertificatesInput

SetFilters sets the Filters field's value.

func (*DescribeCertificatesInput) SetMarker added in v1.25.3 

func (s *DescribeCertificatesInput) SetMarker(v string) *DescribeCertificatesInput

SetMarker sets the Marker field's value.

func (*DescribeCertificatesInput) SetMaxRecords added in v1.25.3 

func (s *DescribeCertificatesInput) SetMaxRecords(v int64) *DescribeCertificatesInput

SetMaxRecords sets the MaxRecords field's value.

func (DescribeCertificatesInput) String added in v1.25.3 

func (s DescribeCertificatesInput) 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 (*DescribeCertificatesInput) Validate added in v1.25.3 

func (s *DescribeCertificatesInput) Validate() error

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

type DescribeCertificatesOutput added in v1.25.3 

type DescribeCertificatesOutput struct {

	// A list of certificates for this Amazon Web Services account.
	Certificates []*Certificate `locationNameList:"Certificate" type:"list"`

	// An optional pagination token provided if the number of records retrieved
	// is greater than MaxRecords. If this parameter is specified, the marker specifies
	// the next record in the list. Including the value of Marker in the next call
	// to DescribeCertificates results in the next page of certificates.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeCertificatesOutput) GoString added in v1.25.3 

func (s DescribeCertificatesOutput) 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 (*DescribeCertificatesOutput) SetCertificates added in v1.25.3 

func (s *DescribeCertificatesOutput) SetCertificates(v []*Certificate) *DescribeCertificatesOutput

SetCertificates sets the Certificates field's value.

func (*DescribeCertificatesOutput) SetMarker added in v1.25.3 

func (s *DescribeCertificatesOutput) SetMarker(v string) *DescribeCertificatesOutput

SetMarker sets the Marker field's value.

func (DescribeCertificatesOutput) String added in v1.25.3 

func (s DescribeCertificatesOutput) 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 DescribeDBClusterParameterGroupsInput 

type DescribeDBClusterParameterGroupsInput struct {

	// The name of a specific cluster parameter group to return details for.
	//
	// Constraints:
	//
	//    * If provided, must match the name of an existing DBClusterParameterGroup.
	DBClusterParameterGroupName *string `type:"string"`

	// This parameter is not currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token (marker) is
	// included in the response so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents the input to DescribeDBClusterParameterGroups.

func (DescribeDBClusterParameterGroupsInput) GoString 

func (s DescribeDBClusterParameterGroupsInput) 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 (*DescribeDBClusterParameterGroupsInput) SetDBClusterParameterGroupName 

func (s *DescribeDBClusterParameterGroupsInput) SetDBClusterParameterGroupName(v string) *DescribeDBClusterParameterGroupsInput

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*DescribeDBClusterParameterGroupsInput) SetFilters 

func (s *DescribeDBClusterParameterGroupsInput) SetFilters(v []*Filter) *DescribeDBClusterParameterGroupsInput

SetFilters sets the Filters field's value.

func (*DescribeDBClusterParameterGroupsInput) SetMarker 

func (s *DescribeDBClusterParameterGroupsInput) SetMarker(v string) *DescribeDBClusterParameterGroupsInput

SetMarker sets the Marker field's value.

func (*DescribeDBClusterParameterGroupsInput) SetMaxRecords 

func (s *DescribeDBClusterParameterGroupsInput) SetMaxRecords(v int64) *DescribeDBClusterParameterGroupsInput

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBClusterParameterGroupsInput) String 

func (s DescribeDBClusterParameterGroupsInput) 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 (*DescribeDBClusterParameterGroupsInput) Validate 

func (s *DescribeDBClusterParameterGroupsInput) Validate() error

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

type DescribeDBClusterParameterGroupsOutput 

type DescribeDBClusterParameterGroupsOutput struct {

	// A list of cluster parameter groups.
	DBClusterParameterGroups []*DBClusterParameterGroup `locationNameList:"DBClusterParameterGroup" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of DBClusterParameterGroups.

func (DescribeDBClusterParameterGroupsOutput) GoString 

func (s DescribeDBClusterParameterGroupsOutput) 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 (*DescribeDBClusterParameterGroupsOutput) SetDBClusterParameterGroups 

func (s *DescribeDBClusterParameterGroupsOutput) SetDBClusterParameterGroups(v []*DBClusterParameterGroup) *DescribeDBClusterParameterGroupsOutput

SetDBClusterParameterGroups sets the DBClusterParameterGroups field's value.

func (*DescribeDBClusterParameterGroupsOutput) SetMarker 

func (s *DescribeDBClusterParameterGroupsOutput) SetMarker(v string) *DescribeDBClusterParameterGroupsOutput

SetMarker sets the Marker field's value.

func (DescribeDBClusterParameterGroupsOutput) String 

func (s DescribeDBClusterParameterGroupsOutput) 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 DescribeDBClusterParametersInput 

type DescribeDBClusterParametersInput struct {

	// The name of a specific cluster parameter group to return parameter details
	// for.
	//
	// Constraints:
	//
	//    * If provided, must match the name of an existing DBClusterParameterGroup.
	//
	// DBClusterParameterGroupName is a required field
	DBClusterParameterGroupName *string `type:"string" required:"true"`

	// This parameter is not currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token (marker) is
	// included in the response so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`

	// A value that indicates to return only parameters for a specific source. Parameter
	// sources can be engine, service, or customer.
	Source *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the input to DescribeDBClusterParameters.

func (DescribeDBClusterParametersInput) GoString 

func (s DescribeDBClusterParametersInput) 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 (*DescribeDBClusterParametersInput) SetDBClusterParameterGroupName 

func (s *DescribeDBClusterParametersInput) SetDBClusterParameterGroupName(v string) *DescribeDBClusterParametersInput

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*DescribeDBClusterParametersInput) SetFilters 

func (s *DescribeDBClusterParametersInput) SetFilters(v []*Filter) *DescribeDBClusterParametersInput

SetFilters sets the Filters field's value.

func (*DescribeDBClusterParametersInput) SetMarker 

func (s *DescribeDBClusterParametersInput) SetMarker(v string) *DescribeDBClusterParametersInput

SetMarker sets the Marker field's value.

func (*DescribeDBClusterParametersInput) SetMaxRecords 

func (s *DescribeDBClusterParametersInput) SetMaxRecords(v int64) *DescribeDBClusterParametersInput

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeDBClusterParametersInput) SetSource 

func (s *DescribeDBClusterParametersInput) SetSource(v string) *DescribeDBClusterParametersInput

SetSource sets the Source field's value.

func (DescribeDBClusterParametersInput) String 

func (s DescribeDBClusterParametersInput) 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 (*DescribeDBClusterParametersInput) Validate 

func (s *DescribeDBClusterParametersInput) Validate() error

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

type DescribeDBClusterParametersOutput 

type DescribeDBClusterParametersOutput struct {

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// Provides a list of parameters for the cluster parameter group.
	Parameters []*Parameter `locationNameList:"Parameter" type:"list"`
	// contains filtered or unexported fields
}

Represents the output of DBClusterParameterGroup.

func (DescribeDBClusterParametersOutput) GoString 

func (s DescribeDBClusterParametersOutput) 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 (*DescribeDBClusterParametersOutput) SetMarker 

func (s *DescribeDBClusterParametersOutput) SetMarker(v string) *DescribeDBClusterParametersOutput

SetMarker sets the Marker field's value.

func (*DescribeDBClusterParametersOutput) SetParameters 

func (s *DescribeDBClusterParametersOutput) SetParameters(v []*Parameter) *DescribeDBClusterParametersOutput

SetParameters sets the Parameters field's value.

func (DescribeDBClusterParametersOutput) String 

func (s DescribeDBClusterParametersOutput) 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 DescribeDBClusterSnapshotAttributesInput 

type DescribeDBClusterSnapshotAttributesInput struct {

	// The identifier for the cluster snapshot to describe the attributes for.
	//
	// DBClusterSnapshotIdentifier is a required field
	DBClusterSnapshotIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to DescribeDBClusterSnapshotAttributes.

func (DescribeDBClusterSnapshotAttributesInput) GoString 

func (s DescribeDBClusterSnapshotAttributesInput) 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 (*DescribeDBClusterSnapshotAttributesInput) SetDBClusterSnapshotIdentifier 

func (s *DescribeDBClusterSnapshotAttributesInput) SetDBClusterSnapshotIdentifier(v string) *DescribeDBClusterSnapshotAttributesInput

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (DescribeDBClusterSnapshotAttributesInput) String 

func (s DescribeDBClusterSnapshotAttributesInput) 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 (*DescribeDBClusterSnapshotAttributesInput) Validate 

func (s *DescribeDBClusterSnapshotAttributesInput) Validate() error

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

type DescribeDBClusterSnapshotAttributesOutput 

type DescribeDBClusterSnapshotAttributesOutput struct {

	// Detailed information about the attributes that are associated with a cluster
	// snapshot.
	DBClusterSnapshotAttributesResult *DBClusterSnapshotAttributesResult `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeDBClusterSnapshotAttributesOutput) GoString 

func (s DescribeDBClusterSnapshotAttributesOutput) 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 (*DescribeDBClusterSnapshotAttributesOutput) SetDBClusterSnapshotAttributesResult 

func (s *DescribeDBClusterSnapshotAttributesOutput) SetDBClusterSnapshotAttributesResult(v *DBClusterSnapshotAttributesResult) *DescribeDBClusterSnapshotAttributesOutput

SetDBClusterSnapshotAttributesResult sets the DBClusterSnapshotAttributesResult field's value.

func (DescribeDBClusterSnapshotAttributesOutput) String 

func (s DescribeDBClusterSnapshotAttributesOutput) 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 DescribeDBClusterSnapshotsInput 

type DescribeDBClusterSnapshotsInput struct {

	// The ID of the cluster to retrieve the list of cluster snapshots for. This
	// parameter can't be used with the DBClusterSnapshotIdentifier parameter. This
	// parameter is not case sensitive.
	//
	// Constraints:
	//
	//    * If provided, must match the identifier of an existing DBCluster.
	DBClusterIdentifier *string `type:"string"`

	// A specific cluster snapshot identifier to describe. This parameter can't
	// be used with the DBClusterIdentifier parameter. This value is stored as a
	// lowercase string.
	//
	// Constraints:
	//
	//    * If provided, must match the identifier of an existing DBClusterSnapshot.
	//
	//    * If this identifier is for an automated snapshot, the SnapshotType parameter
	//    must also be specified.
	DBClusterSnapshotIdentifier *string `type:"string"`

	// This parameter is not currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// Set to true to include manual cluster snapshots that are public and can be
	// copied or restored by any Amazon Web Services account, and otherwise false.
	// The default is false.
	IncludePublic *bool `type:"boolean"`

	// Set to true to include shared manual cluster snapshots from other Amazon
	// Web Services accounts that this Amazon Web Services account has been given
	// permission to copy or restore, and otherwise false. The default is false.
	IncludeShared *bool `type:"boolean"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token (marker) is
	// included in the response so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`

	// 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.
	//
	//    * shared - Return all manual cluster snapshots that have been shared to
	//    your Amazon Web Services account.
	//
	//    * public - Return all cluster snapshots that have been marked as public.
	//
	// If you don't specify a SnapshotType value, then both automated and manual
	// cluster snapshots are returned. You can include shared cluster snapshots
	// with these results by setting the IncludeShared parameter to true. You can
	// include public cluster snapshots with these results by setting theIncludePublic
	// parameter to true.
	//
	// The IncludeShared and IncludePublic parameters don't apply for SnapshotType
	// values of manual or automated. The IncludePublic parameter doesn't apply
	// when SnapshotType is set to shared. The IncludeShared parameter doesn't apply
	// when SnapshotType is set to public.
	SnapshotType *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the input to DescribeDBClusterSnapshots.

func (DescribeDBClusterSnapshotsInput) GoString 

func (s DescribeDBClusterSnapshotsInput) 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 (*DescribeDBClusterSnapshotsInput) SetDBClusterIdentifier 

func (s *DescribeDBClusterSnapshotsInput) SetDBClusterIdentifier(v string) *DescribeDBClusterSnapshotsInput

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DescribeDBClusterSnapshotsInput) SetDBClusterSnapshotIdentifier 

func (s *DescribeDBClusterSnapshotsInput) SetDBClusterSnapshotIdentifier(v string) *DescribeDBClusterSnapshotsInput

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (*DescribeDBClusterSnapshotsInput) SetFilters 

func (s *DescribeDBClusterSnapshotsInput) SetFilters(v []*Filter) *DescribeDBClusterSnapshotsInput

SetFilters sets the Filters field's value.

func (*DescribeDBClusterSnapshotsInput) SetIncludePublic 

func (s *DescribeDBClusterSnapshotsInput) SetIncludePublic(v bool) *DescribeDBClusterSnapshotsInput

SetIncludePublic sets the IncludePublic field's value.

func (*DescribeDBClusterSnapshotsInput) SetIncludeShared 

func (s *DescribeDBClusterSnapshotsInput) SetIncludeShared(v bool) *DescribeDBClusterSnapshotsInput

SetIncludeShared sets the IncludeShared field's value.

func (*DescribeDBClusterSnapshotsInput) SetMarker 

func (s *DescribeDBClusterSnapshotsInput) SetMarker(v string) *DescribeDBClusterSnapshotsInput

SetMarker sets the Marker field's value.

func (*DescribeDBClusterSnapshotsInput) SetMaxRecords 

func (s *DescribeDBClusterSnapshotsInput) SetMaxRecords(v int64) *DescribeDBClusterSnapshotsInput

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeDBClusterSnapshotsInput) SetSnapshotType 

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

SetSnapshotType sets the SnapshotType field's value.

func (DescribeDBClusterSnapshotsInput) String 

func (s DescribeDBClusterSnapshotsInput) 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 (*DescribeDBClusterSnapshotsInput) Validate 

func (s *DescribeDBClusterSnapshotsInput) Validate() error

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

type DescribeDBClusterSnapshotsOutput 

type DescribeDBClusterSnapshotsOutput struct {

	// Provides a list of cluster snapshots.
	DBClusterSnapshots []*DBClusterSnapshot `locationNameList:"DBClusterSnapshot" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of DescribeDBClusterSnapshots.

func (DescribeDBClusterSnapshotsOutput) GoString 

func (s DescribeDBClusterSnapshotsOutput) 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 (*DescribeDBClusterSnapshotsOutput) SetDBClusterSnapshots 

func (s *DescribeDBClusterSnapshotsOutput) SetDBClusterSnapshots(v []*DBClusterSnapshot) *DescribeDBClusterSnapshotsOutput

SetDBClusterSnapshots sets the DBClusterSnapshots field's value.

func (*DescribeDBClusterSnapshotsOutput) SetMarker 

func (s *DescribeDBClusterSnapshotsOutput) SetMarker(v string) *DescribeDBClusterSnapshotsOutput

SetMarker sets the Marker field's value.

func (DescribeDBClusterSnapshotsOutput) String 

func (s DescribeDBClusterSnapshotsOutput) 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 DescribeDBClustersInput 

type DescribeDBClustersInput struct {

	// The user-provided cluster identifier. If this parameter is specified, information
	// from only the specific cluster is returned. This parameter isn't case sensitive.
	//
	// Constraints:
	//
	//    * If provided, must match an existing DBClusterIdentifier.
	DBClusterIdentifier *string `type:"string"`

	// A filter that specifies one or more clusters to describe.
	//
	// Supported filters:
	//
	//    * db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource
	//    Names (ARNs). The results list only includes information about the clusters
	//    identified by these ARNs.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token (marker) is
	// included in the response so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents the input to DescribeDBClusters.

func (DescribeDBClustersInput) GoString 

func (s DescribeDBClustersInput) 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 (*DescribeDBClustersInput) SetDBClusterIdentifier 

func (s *DescribeDBClustersInput) SetDBClusterIdentifier(v string) *DescribeDBClustersInput

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DescribeDBClustersInput) SetFilters 

func (s *DescribeDBClustersInput) SetFilters(v []*Filter) *DescribeDBClustersInput

SetFilters sets the Filters field's value.

func (*DescribeDBClustersInput) SetMarker 

func (s *DescribeDBClustersInput) SetMarker(v string) *DescribeDBClustersInput

SetMarker sets the Marker field's value.

func (*DescribeDBClustersInput) SetMaxRecords 

func (s *DescribeDBClustersInput) SetMaxRecords(v int64) *DescribeDBClustersInput

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBClustersInput) String 

func (s DescribeDBClustersInput) 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 (*DescribeDBClustersInput) Validate 

func (s *DescribeDBClustersInput) Validate() error

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

type DescribeDBClustersOutput 

type DescribeDBClustersOutput struct {

	// A list of clusters.
	DBClusters []*DBCluster `locationNameList:"DBCluster" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of DescribeDBClusters.

func (DescribeDBClustersOutput) GoString 

func (s DescribeDBClustersOutput) 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 (*DescribeDBClustersOutput) SetDBClusters 

func (s *DescribeDBClustersOutput) SetDBClusters(v []*DBCluster) *DescribeDBClustersOutput

SetDBClusters sets the DBClusters field's value.

func (*DescribeDBClustersOutput) SetMarker 

func (s *DescribeDBClustersOutput) SetMarker(v string) *DescribeDBClustersOutput

SetMarker sets the Marker field's value.

func (DescribeDBClustersOutput) String 

func (s DescribeDBClustersOutput) 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 DescribeDBEngineVersionsInput 

type DescribeDBEngineVersionsInput struct {

	// The name of a specific parameter group family to return details for.
	//
	// Constraints:
	//
	//    * If provided, must match an existing DBParameterGroupFamily.
	DBParameterGroupFamily *string `type:"string"`

	// Indicates that only the default version of the specified engine or engine
	// and major version combination is returned.
	DefaultOnly *bool `type:"boolean"`

	// The database engine to return.
	Engine *string `type:"string"`

	// The database engine version to return.
	//
	// Example: 3.6.0
	EngineVersion *string `type:"string"`

	// This parameter is not currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// If this parameter is specified and the requested engine supports the CharacterSetName
	// parameter for CreateDBInstance, the response includes a list of supported
	// character sets for each engine version.
	ListSupportedCharacterSets *bool `type:"boolean"`

	// If this parameter is specified and the requested engine supports the TimeZone
	// parameter for CreateDBInstance, the response includes a list of supported
	// time zones for each engine version.
	ListSupportedTimezones *bool `type:"boolean"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token (marker) is
	// included in the response so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents the input to DescribeDBEngineVersions.

func (DescribeDBEngineVersionsInput) GoString 

func (s DescribeDBEngineVersionsInput) 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 (*DescribeDBEngineVersionsInput) SetDBParameterGroupFamily 

func (s *DescribeDBEngineVersionsInput) SetDBParameterGroupFamily(v string) *DescribeDBEngineVersionsInput

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*DescribeDBEngineVersionsInput) SetDefaultOnly 

func (s *DescribeDBEngineVersionsInput) SetDefaultOnly(v bool) *DescribeDBEngineVersionsInput

SetDefaultOnly sets the DefaultOnly field's value.

func (*DescribeDBEngineVersionsInput) SetEngine 

func (s *DescribeDBEngineVersionsInput) SetEngine(v string) *DescribeDBEngineVersionsInput

SetEngine sets the Engine field's value.

func (*DescribeDBEngineVersionsInput) SetEngineVersion 

func (s *DescribeDBEngineVersionsInput) SetEngineVersion(v string) *DescribeDBEngineVersionsInput

SetEngineVersion sets the EngineVersion field's value.

func (*DescribeDBEngineVersionsInput) SetFilters 

func (s *DescribeDBEngineVersionsInput) SetFilters(v []*Filter) *DescribeDBEngineVersionsInput

SetFilters sets the Filters field's value.

func (*DescribeDBEngineVersionsInput) SetListSupportedCharacterSets 

func (s *DescribeDBEngineVersionsInput) SetListSupportedCharacterSets(v bool) *DescribeDBEngineVersionsInput

SetListSupportedCharacterSets sets the ListSupportedCharacterSets field's value.

func (*DescribeDBEngineVersionsInput) SetListSupportedTimezones 

func (s *DescribeDBEngineVersionsInput) SetListSupportedTimezones(v bool) *DescribeDBEngineVersionsInput

SetListSupportedTimezones sets the ListSupportedTimezones field's value.

func (*DescribeDBEngineVersionsInput) SetMarker 

func (s *DescribeDBEngineVersionsInput) SetMarker(v string) *DescribeDBEngineVersionsInput

SetMarker sets the Marker field's value.

func (*DescribeDBEngineVersionsInput) SetMaxRecords 

func (s *DescribeDBEngineVersionsInput) SetMaxRecords(v int64) *DescribeDBEngineVersionsInput

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBEngineVersionsInput) String 

func (s DescribeDBEngineVersionsInput) 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 (*DescribeDBEngineVersionsInput) Validate 

func (s *DescribeDBEngineVersionsInput) Validate() error

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

type DescribeDBEngineVersionsOutput 

type DescribeDBEngineVersionsOutput struct {

	// Detailed information about one or more engine versions.
	DBEngineVersions []*DBEngineVersion `locationNameList:"DBEngineVersion" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of DescribeDBEngineVersions.

func (DescribeDBEngineVersionsOutput) GoString 

func (s DescribeDBEngineVersionsOutput) 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 (*DescribeDBEngineVersionsOutput) SetDBEngineVersions 

func (s *DescribeDBEngineVersionsOutput) SetDBEngineVersions(v []*DBEngineVersion) *DescribeDBEngineVersionsOutput

SetDBEngineVersions sets the DBEngineVersions field's value.

func (*DescribeDBEngineVersionsOutput) SetMarker 

func (s *DescribeDBEngineVersionsOutput) SetMarker(v string) *DescribeDBEngineVersionsOutput

SetMarker sets the Marker field's value.

func (DescribeDBEngineVersionsOutput) String 

func (s DescribeDBEngineVersionsOutput) 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 DescribeDBInstancesInput 

type DescribeDBInstancesInput struct {

	// The user-provided instance identifier. If this parameter is specified, information
	// from only the specific instance is returned. This parameter isn't case sensitive.
	//
	// Constraints:
	//
	//    * If provided, must match the identifier of an existing DBInstance.
	DBInstanceIdentifier *string `type:"string"`

	// A filter that specifies one or more instances to describe.
	//
	// Supported filters:
	//
	//    * db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource
	//    Names (ARNs). The results list includes only the information about the
	//    instances that are associated with the clusters that are identified by
	//    these ARNs.
	//
	//    * db-instance-id - Accepts instance identifiers and instance ARNs. The
	//    results list includes only the information about the instances that are
	//    identified by these ARNs.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token (marker) is
	// included in the response so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents the input to DescribeDBInstances.

func (DescribeDBInstancesInput) GoString 

func (s DescribeDBInstancesInput) 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 (*DescribeDBInstancesInput) SetDBInstanceIdentifier 

func (s *DescribeDBInstancesInput) SetDBInstanceIdentifier(v string) *DescribeDBInstancesInput

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*DescribeDBInstancesInput) SetFilters 

func (s *DescribeDBInstancesInput) SetFilters(v []*Filter) *DescribeDBInstancesInput

SetFilters sets the Filters field's value.

func (*DescribeDBInstancesInput) SetMarker 

func (s *DescribeDBInstancesInput) SetMarker(v string) *DescribeDBInstancesInput

SetMarker sets the Marker field's value.

func (*DescribeDBInstancesInput) SetMaxRecords 

func (s *DescribeDBInstancesInput) SetMaxRecords(v int64) *DescribeDBInstancesInput

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBInstancesInput) String 

func (s DescribeDBInstancesInput) 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 (*DescribeDBInstancesInput) Validate 

func (s *DescribeDBInstancesInput) Validate() error

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

type DescribeDBInstancesOutput 

type DescribeDBInstancesOutput struct {

	// Detailed information about one or more instances.
	DBInstances []*DBInstance `locationNameList:"DBInstance" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of DescribeDBInstances.

func (DescribeDBInstancesOutput) GoString 

func (s DescribeDBInstancesOutput) 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 (*DescribeDBInstancesOutput) SetDBInstances 

func (s *DescribeDBInstancesOutput) SetDBInstances(v []*DBInstance) *DescribeDBInstancesOutput

SetDBInstances sets the DBInstances field's value.

func (*DescribeDBInstancesOutput) SetMarker 

func (s *DescribeDBInstancesOutput) SetMarker(v string) *DescribeDBInstancesOutput

SetMarker sets the Marker field's value.

func (DescribeDBInstancesOutput) String 

func (s DescribeDBInstancesOutput) 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 DescribeDBSubnetGroupsInput 

type DescribeDBSubnetGroupsInput struct {

	// The name of the subnet group to return details for.
	DBSubnetGroupName *string `type:"string"`

	// This parameter is not currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token (marker) is
	// included in the response so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents the input to DescribeDBSubnetGroups.

func (DescribeDBSubnetGroupsInput) GoString 

func (s DescribeDBSubnetGroupsInput) 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 (*DescribeDBSubnetGroupsInput) SetDBSubnetGroupName 

func (s *DescribeDBSubnetGroupsInput) SetDBSubnetGroupName(v string) *DescribeDBSubnetGroupsInput

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*DescribeDBSubnetGroupsInput) SetFilters 

func (s *DescribeDBSubnetGroupsInput) SetFilters(v []*Filter) *DescribeDBSubnetGroupsInput

SetFilters sets the Filters field's value.

func (*DescribeDBSubnetGroupsInput) SetMarker 

func (s *DescribeDBSubnetGroupsInput) SetMarker(v string) *DescribeDBSubnetGroupsInput

SetMarker sets the Marker field's value.

func (*DescribeDBSubnetGroupsInput) SetMaxRecords 

func (s *DescribeDBSubnetGroupsInput) SetMaxRecords(v int64) *DescribeDBSubnetGroupsInput

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBSubnetGroupsInput) String 

func (s DescribeDBSubnetGroupsInput) 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 (*DescribeDBSubnetGroupsInput) Validate 

func (s *DescribeDBSubnetGroupsInput) Validate() error

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

type DescribeDBSubnetGroupsOutput 

type DescribeDBSubnetGroupsOutput struct {

	// Detailed information about one or more subnet groups.
	DBSubnetGroups []*DBSubnetGroup `locationNameList:"DBSubnetGroup" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of DescribeDBSubnetGroups.

func (DescribeDBSubnetGroupsOutput) GoString 

func (s DescribeDBSubnetGroupsOutput) 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 (*DescribeDBSubnetGroupsOutput) SetDBSubnetGroups 

func (s *DescribeDBSubnetGroupsOutput) SetDBSubnetGroups(v []*DBSubnetGroup) *DescribeDBSubnetGroupsOutput

SetDBSubnetGroups sets the DBSubnetGroups field's value.

func (*DescribeDBSubnetGroupsOutput) SetMarker 

func (s *DescribeDBSubnetGroupsOutput) SetMarker(v string) *DescribeDBSubnetGroupsOutput

SetMarker sets the Marker field's value.

func (DescribeDBSubnetGroupsOutput) String 

func (s DescribeDBSubnetGroupsOutput) 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 DescribeEngineDefaultClusterParametersInput 

type DescribeEngineDefaultClusterParametersInput struct {

	// The name of the cluster parameter group family to return the engine parameter
	// information for.
	//
	// DBParameterGroupFamily is a required field
	DBParameterGroupFamily *string `type:"string" required:"true"`

	// This parameter is not currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token (marker) is
	// included in the response so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents the input to DescribeEngineDefaultClusterParameters.

func (DescribeEngineDefaultClusterParametersInput) GoString 

func (s DescribeEngineDefaultClusterParametersInput) 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 (*DescribeEngineDefaultClusterParametersInput) SetDBParameterGroupFamily 

func (s *DescribeEngineDefaultClusterParametersInput) SetDBParameterGroupFamily(v string) *DescribeEngineDefaultClusterParametersInput

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*DescribeEngineDefaultClusterParametersInput) SetFilters 

func (s *DescribeEngineDefaultClusterParametersInput) SetFilters(v []*Filter) *DescribeEngineDefaultClusterParametersInput

SetFilters sets the Filters field's value.

func (*DescribeEngineDefaultClusterParametersInput) SetMarker 

func (s *DescribeEngineDefaultClusterParametersInput) SetMarker(v string) *DescribeEngineDefaultClusterParametersInput

SetMarker sets the Marker field's value.

func (*DescribeEngineDefaultClusterParametersInput) SetMaxRecords 

func (s *DescribeEngineDefaultClusterParametersInput) SetMaxRecords(v int64) *DescribeEngineDefaultClusterParametersInput

SetMaxRecords sets the MaxRecords field's value.

func (DescribeEngineDefaultClusterParametersInput) String 

func (s DescribeEngineDefaultClusterParametersInput) 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 (*DescribeEngineDefaultClusterParametersInput) Validate 

func (s *DescribeEngineDefaultClusterParametersInput) Validate() error

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

type DescribeEngineDefaultClusterParametersOutput 

type DescribeEngineDefaultClusterParametersOutput struct {

	// Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters
	// operation.
	EngineDefaults *EngineDefaults `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeEngineDefaultClusterParametersOutput) GoString 

func (s DescribeEngineDefaultClusterParametersOutput) 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 (*DescribeEngineDefaultClusterParametersOutput) SetEngineDefaults 

func (s *DescribeEngineDefaultClusterParametersOutput) SetEngineDefaults(v *EngineDefaults) *DescribeEngineDefaultClusterParametersOutput

SetEngineDefaults sets the EngineDefaults field's value.

func (DescribeEngineDefaultClusterParametersOutput) String 

func (s DescribeEngineDefaultClusterParametersOutput) 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 DescribeEventCategoriesInput 

type DescribeEventCategoriesInput struct {

	// This parameter is not currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// The type of source that is generating the events.
	//
	// Valid values: db-instance, db-parameter-group, db-security-group
	SourceType *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the input to DescribeEventCategories.

func (DescribeEventCategoriesInput) GoString 

func (s DescribeEventCategoriesInput) 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 (*DescribeEventCategoriesInput) SetFilters 

func (s *DescribeEventCategoriesInput) SetFilters(v []*Filter) *DescribeEventCategoriesInput

SetFilters sets the Filters field's value.

func (*DescribeEventCategoriesInput) SetSourceType 

func (s *DescribeEventCategoriesInput) SetSourceType(v string) *DescribeEventCategoriesInput

SetSourceType sets the SourceType field's value.

func (DescribeEventCategoriesInput) String 

func (s DescribeEventCategoriesInput) 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 (*DescribeEventCategoriesInput) Validate 

func (s *DescribeEventCategoriesInput) Validate() error

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

type DescribeEventCategoriesOutput 

type DescribeEventCategoriesOutput struct {

	// A list of event category maps.
	EventCategoriesMapList []*EventCategoriesMap `locationNameList:"EventCategoriesMap" type:"list"`
	// contains filtered or unexported fields
}

Represents the output of DescribeEventCategories.

func (DescribeEventCategoriesOutput) GoString 

func (s DescribeEventCategoriesOutput) 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 (*DescribeEventCategoriesOutput) SetEventCategoriesMapList 

func (s *DescribeEventCategoriesOutput) SetEventCategoriesMapList(v []*EventCategoriesMap) *DescribeEventCategoriesOutput

SetEventCategoriesMapList sets the EventCategoriesMapList field's value.

func (DescribeEventCategoriesOutput) String 

func (s DescribeEventCategoriesOutput) 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 DescribeEventSubscriptionsInput added in v1.38.8 

type DescribeEventSubscriptionsInput struct {

	// This parameter is not currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token (marker) is
	// included in the response so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`

	// The name of the Amazon DocumentDB event notification subscription that you
	// want to describe.
	SubscriptionName *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the input to DescribeEventSubscriptions.

func (DescribeEventSubscriptionsInput) GoString added in v1.38.8 

func (s DescribeEventSubscriptionsInput) 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 (*DescribeEventSubscriptionsInput) SetFilters added in v1.38.8 

func (s *DescribeEventSubscriptionsInput) SetFilters(v []*Filter) *DescribeEventSubscriptionsInput

SetFilters sets the Filters field's value.

func (*DescribeEventSubscriptionsInput) SetMarker added in v1.38.8 

func (s *DescribeEventSubscriptionsInput) SetMarker(v string) *DescribeEventSubscriptionsInput

SetMarker sets the Marker field's value.

func (*DescribeEventSubscriptionsInput) SetMaxRecords added in v1.38.8 

func (s *DescribeEventSubscriptionsInput) SetMaxRecords(v int64) *DescribeEventSubscriptionsInput

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeEventSubscriptionsInput) SetSubscriptionName added in v1.38.8 

func (s *DescribeEventSubscriptionsInput) SetSubscriptionName(v string) *DescribeEventSubscriptionsInput

SetSubscriptionName sets the SubscriptionName field's value.

func (DescribeEventSubscriptionsInput) String added in v1.38.8 

func (s DescribeEventSubscriptionsInput) 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 (*DescribeEventSubscriptionsInput) Validate added in v1.38.8 

func (s *DescribeEventSubscriptionsInput) Validate() error

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

type DescribeEventSubscriptionsOutput added in v1.38.8 

type DescribeEventSubscriptionsOutput struct {

	// A list of event subscriptions.
	EventSubscriptionsList []*EventSubscription `locationNameList:"EventSubscription" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of DescribeEventSubscriptions.

func (DescribeEventSubscriptionsOutput) GoString added in v1.38.8 

func (s DescribeEventSubscriptionsOutput) 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 (*DescribeEventSubscriptionsOutput) SetEventSubscriptionsList added in v1.38.8 

func (s *DescribeEventSubscriptionsOutput) SetEventSubscriptionsList(v []*EventSubscription) *DescribeEventSubscriptionsOutput

SetEventSubscriptionsList sets the EventSubscriptionsList field's value.

func (*DescribeEventSubscriptionsOutput) SetMarker added in v1.38.8 

func (s *DescribeEventSubscriptionsOutput) SetMarker(v string) *DescribeEventSubscriptionsOutput

SetMarker sets the Marker field's value.

func (DescribeEventSubscriptionsOutput) String added in v1.38.8 

func (s DescribeEventSubscriptionsOutput) 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 DescribeEventsInput 

type DescribeEventsInput struct {

	// The number of minutes to retrieve events for.
	//
	// Default: 60
	Duration *int64 `type:"integer"`

	// The end of the time interval for which to retrieve events, specified in ISO
	// 8601 format.
	//
	// Example: 2009-07-08T18:00Z
	EndTime *time.Time `type:"timestamp"`

	// A list of event categories that trigger notifications for an event notification
	// subscription.
	EventCategories []*string `locationNameList:"EventCategory" type:"list"`

	// This parameter is not currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token (marker) is
	// included in the response so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`

	// The identifier of the event source for which events are returned. If not
	// specified, then all sources are included in the response.
	//
	// Constraints:
	//
	//    * If SourceIdentifier is provided, SourceType must also be provided.
	//
	//    * If the source type is DBInstance, a DBInstanceIdentifier must be provided.
	//
	//    * If the source type is DBSecurityGroup, a DBSecurityGroupName must be
	//    provided.
	//
	//    * If the source type is DBParameterGroup, a DBParameterGroupName must
	//    be provided.
	//
	//    * If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.
	//
	//    * Cannot end with a hyphen or contain two consecutive hyphens.
	SourceIdentifier *string `type:"string"`

	// The event source to retrieve events for. If no value is specified, all events
	// are returned.
	SourceType *string `type:"string" enum:"SourceType"`

	// The beginning of the time interval to retrieve events for, specified in ISO
	// 8601 format.
	//
	// Example: 2009-07-08T18:00Z
	StartTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Represents the input to DescribeEvents.

func (DescribeEventsInput) GoString 

func (s DescribeEventsInput) 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 (*DescribeEventsInput) SetDuration 

func (s *DescribeEventsInput) SetDuration(v int64) *DescribeEventsInput

SetDuration sets the Duration field's value.

func (*DescribeEventsInput) SetEndTime 

func (s *DescribeEventsInput) SetEndTime(v time.Time) *DescribeEventsInput

SetEndTime sets the EndTime field's value.

func (*DescribeEventsInput) SetEventCategories 

func (s *DescribeEventsInput) SetEventCategories(v []*string) *DescribeEventsInput

SetEventCategories sets the EventCategories field's value.

func (*DescribeEventsInput) SetFilters 

func (s *DescribeEventsInput) SetFilters(v []*Filter) *DescribeEventsInput

SetFilters sets the Filters field's value.

func (*DescribeEventsInput) SetMarker 

func (s *DescribeEventsInput) SetMarker(v string) *DescribeEventsInput

SetMarker sets the Marker field's value.

func (*DescribeEventsInput) SetMaxRecords 

func (s *DescribeEventsInput) SetMaxRecords(v int64) *DescribeEventsInput

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeEventsInput) SetSourceIdentifier 

func (s *DescribeEventsInput) SetSourceIdentifier(v string) *DescribeEventsInput

SetSourceIdentifier sets the SourceIdentifier field's value.

func (*DescribeEventsInput) SetSourceType 

func (s *DescribeEventsInput) SetSourceType(v string) *DescribeEventsInput

SetSourceType sets the SourceType field's value.

func (*DescribeEventsInput) SetStartTime 

func (s *DescribeEventsInput) SetStartTime(v time.Time) *DescribeEventsInput

SetStartTime sets the StartTime field's value.

func (DescribeEventsInput) String 

func (s DescribeEventsInput) 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 (*DescribeEventsInput) Validate 

func (s *DescribeEventsInput) Validate() error

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

type DescribeEventsOutput 

type DescribeEventsOutput struct {

	// Detailed information about one or more events.
	Events []*Event `locationNameList:"Event" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of DescribeEvents.

func (DescribeEventsOutput) GoString 

func (s DescribeEventsOutput) 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 (*DescribeEventsOutput) SetEvents 

func (s *DescribeEventsOutput) SetEvents(v []*Event) *DescribeEventsOutput

SetEvents sets the Events field's value.

func (*DescribeEventsOutput) SetMarker 

func (s *DescribeEventsOutput) SetMarker(v string) *DescribeEventsOutput

SetMarker sets the Marker field's value.

func (DescribeEventsOutput) String 

func (s DescribeEventsOutput) 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 DescribeGlobalClustersInput added in v1.38.53 

type DescribeGlobalClustersInput struct {

	// A filter that specifies one or more global DB clusters to describe.
	//
	// Supported filters: db-cluster-id accepts cluster identifiers and cluster
	// Amazon Resource Names (ARNs). The results list will only include information
	// about the clusters identified by these ARNs.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// The user-supplied cluster identifier. If this parameter is specified, information
	// from only the specific cluster is returned. This parameter isn't case-sensitive.
	GlobalClusterIdentifier *string `min:"1" type:"string"`

	// An optional pagination token provided by a previous DescribeGlobalClusters
	// request. If this parameter is specified, the response includes only records
	// beyond the marker, up to the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token called a marker
	// is included in the response so that you can retrieve the remaining results.
	MaxRecords *int64 `type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeGlobalClustersInput) GoString added in v1.38.53 

func (s DescribeGlobalClustersInput) 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 (*DescribeGlobalClustersInput) SetFilters added in v1.38.53 

func (s *DescribeGlobalClustersInput) SetFilters(v []*Filter) *DescribeGlobalClustersInput

SetFilters sets the Filters field's value.

func (*DescribeGlobalClustersInput) SetGlobalClusterIdentifier added in v1.38.53 

func (s *DescribeGlobalClustersInput) SetGlobalClusterIdentifier(v string) *DescribeGlobalClustersInput

SetGlobalClusterIdentifier sets the GlobalClusterIdentifier field's value.

func (*DescribeGlobalClustersInput) SetMarker added in v1.38.53 

func (s *DescribeGlobalClustersInput) SetMarker(v string) *DescribeGlobalClustersInput

SetMarker sets the Marker field's value.

func (*DescribeGlobalClustersInput) SetMaxRecords added in v1.38.53 

func (s *DescribeGlobalClustersInput) SetMaxRecords(v int64) *DescribeGlobalClustersInput

SetMaxRecords sets the MaxRecords field's value.

func (DescribeGlobalClustersInput) String added in v1.38.53 

func (s DescribeGlobalClustersInput) 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 (*DescribeGlobalClustersInput) Validate added in v1.38.53 

func (s *DescribeGlobalClustersInput) Validate() error

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

type DescribeGlobalClustersOutput added in v1.38.53 

type DescribeGlobalClustersOutput struct {
	GlobalClusters []*GlobalCluster `locationNameList:"GlobalClusterMember" type:"list"`

	Marker *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeGlobalClustersOutput) GoString added in v1.38.53 

func (s DescribeGlobalClustersOutput) 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 (*DescribeGlobalClustersOutput) SetGlobalClusters added in v1.38.53 

func (s *DescribeGlobalClustersOutput) SetGlobalClusters(v []*GlobalCluster) *DescribeGlobalClustersOutput

SetGlobalClusters sets the GlobalClusters field's value.

func (*DescribeGlobalClustersOutput) SetMarker added in v1.38.53 

func (s *DescribeGlobalClustersOutput) SetMarker(v string) *DescribeGlobalClustersOutput

SetMarker sets the Marker field's value.

func (DescribeGlobalClustersOutput) String added in v1.38.53 

func (s DescribeGlobalClustersOutput) 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 DescribeOrderableDBInstanceOptionsInput 

type DescribeOrderableDBInstanceOptionsInput struct {

	// The instance class filter value. Specify this parameter to show only the
	// available offerings that match the specified instance class.
	DBInstanceClass *string `type:"string"`

	// The name of the engine to retrieve instance options for.
	//
	// Engine is a required field
	Engine *string `type:"string" required:"true"`

	// The engine version filter value. Specify this parameter to show only the
	// available offerings that match the specified engine version.
	EngineVersion *string `type:"string"`

	// This parameter is not currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// The license model filter value. Specify this parameter to show only the available
	// offerings that match the specified license model.
	LicenseModel *string `type:"string"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token (marker) is
	// included in the response so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`

	// The virtual private cloud (VPC) filter value. Specify this parameter to show
	// only the available VPC or non-VPC offerings.
	Vpc *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Represents the input to DescribeOrderableDBInstanceOptions.

func (DescribeOrderableDBInstanceOptionsInput) GoString 

func (s DescribeOrderableDBInstanceOptionsInput) 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 (*DescribeOrderableDBInstanceOptionsInput) SetDBInstanceClass 

func (s *DescribeOrderableDBInstanceOptionsInput) SetDBInstanceClass(v string) *DescribeOrderableDBInstanceOptionsInput

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetEngine 

func (s *DescribeOrderableDBInstanceOptionsInput) SetEngine(v string) *DescribeOrderableDBInstanceOptionsInput

SetEngine sets the Engine field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetEngineVersion 

func (s *DescribeOrderableDBInstanceOptionsInput) SetEngineVersion(v string) *DescribeOrderableDBInstanceOptionsInput

SetEngineVersion sets the EngineVersion field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetFilters 

func (s *DescribeOrderableDBInstanceOptionsInput) SetFilters(v []*Filter) *DescribeOrderableDBInstanceOptionsInput

SetFilters sets the Filters field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetLicenseModel 

func (s *DescribeOrderableDBInstanceOptionsInput) SetLicenseModel(v string) *DescribeOrderableDBInstanceOptionsInput

SetLicenseModel sets the LicenseModel field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetMarker 

func (s *DescribeOrderableDBInstanceOptionsInput) SetMarker(v string) *DescribeOrderableDBInstanceOptionsInput

SetMarker sets the Marker field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetMaxRecords 

func (s *DescribeOrderableDBInstanceOptionsInput) SetMaxRecords(v int64) *DescribeOrderableDBInstanceOptionsInput

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetVpc 

func (s *DescribeOrderableDBInstanceOptionsInput) SetVpc(v bool) *DescribeOrderableDBInstanceOptionsInput

SetVpc sets the Vpc field's value.

func (DescribeOrderableDBInstanceOptionsInput) String 

func (s DescribeOrderableDBInstanceOptionsInput) 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 (*DescribeOrderableDBInstanceOptionsInput) Validate 

func (s *DescribeOrderableDBInstanceOptionsInput) Validate() error

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

type DescribeOrderableDBInstanceOptionsOutput 

type DescribeOrderableDBInstanceOptionsOutput struct {

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The options that are available for a particular orderable instance.
	OrderableDBInstanceOptions []*OrderableDBInstanceOption `locationNameList:"OrderableDBInstanceOption" type:"list"`
	// contains filtered or unexported fields
}

Represents the output of DescribeOrderableDBInstanceOptions.

func (DescribeOrderableDBInstanceOptionsOutput) GoString 

func (s DescribeOrderableDBInstanceOptionsOutput) 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 (*DescribeOrderableDBInstanceOptionsOutput) SetMarker 

func (s *DescribeOrderableDBInstanceOptionsOutput) SetMarker(v string) *DescribeOrderableDBInstanceOptionsOutput

SetMarker sets the Marker field's value.

func (*DescribeOrderableDBInstanceOptionsOutput) SetOrderableDBInstanceOptions 

func (s *DescribeOrderableDBInstanceOptionsOutput) SetOrderableDBInstanceOptions(v []*OrderableDBInstanceOption) *DescribeOrderableDBInstanceOptionsOutput

SetOrderableDBInstanceOptions sets the OrderableDBInstanceOptions field's value.

func (DescribeOrderableDBInstanceOptionsOutput) String 

func (s DescribeOrderableDBInstanceOptionsOutput) 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 DescribePendingMaintenanceActionsInput 

type DescribePendingMaintenanceActionsInput struct {

	// A filter that specifies one or more resources to return pending maintenance
	// actions for.
	//
	// Supported filters:
	//
	//    * db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource
	//    Names (ARNs). The results list includes only pending maintenance actions
	//    for the clusters identified by these ARNs.
	//
	//    * db-instance-id - Accepts instance identifiers and instance ARNs. The
	//    results list includes only pending maintenance actions for the DB instances
	//    identified by these ARNs.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maximum number of records to include in the response. If more records
	// exist than the specified MaxRecords value, a pagination token (marker) is
	// included in the response so that the remaining results can be retrieved.
	//
	// Default: 100
	//
	// Constraints: Minimum 20, maximum 100.
	MaxRecords *int64 `type:"integer"`

	// The ARN of a resource to return pending maintenance actions for.
	ResourceIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the input to DescribePendingMaintenanceActions.

func (DescribePendingMaintenanceActionsInput) GoString 

func (s DescribePendingMaintenanceActionsInput) 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 (*DescribePendingMaintenanceActionsInput) SetFilters 

func (s *DescribePendingMaintenanceActionsInput) SetFilters(v []*Filter) *DescribePendingMaintenanceActionsInput

SetFilters sets the Filters field's value.

func (*DescribePendingMaintenanceActionsInput) SetMarker 

func (s *DescribePendingMaintenanceActionsInput) SetMarker(v string) *DescribePendingMaintenanceActionsInput

SetMarker sets the Marker field's value.

func (*DescribePendingMaintenanceActionsInput) SetMaxRecords 

func (s *DescribePendingMaintenanceActionsInput) SetMaxRecords(v int64) *DescribePendingMaintenanceActionsInput

SetMaxRecords sets the MaxRecords field's value.

func (*DescribePendingMaintenanceActionsInput) SetResourceIdentifier 

func (s *DescribePendingMaintenanceActionsInput) SetResourceIdentifier(v string) *DescribePendingMaintenanceActionsInput

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (DescribePendingMaintenanceActionsInput) String 

func (s DescribePendingMaintenanceActionsInput) 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 (*DescribePendingMaintenanceActionsInput) Validate 

func (s *DescribePendingMaintenanceActionsInput) Validate() error

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

type DescribePendingMaintenanceActionsOutput 

type DescribePendingMaintenanceActionsOutput struct {

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The maintenance actions to be applied.
	PendingMaintenanceActions []*ResourcePendingMaintenanceActions `locationNameList:"ResourcePendingMaintenanceActions" type:"list"`
	// contains filtered or unexported fields
}

Represents the output of DescribePendingMaintenanceActions.

func (DescribePendingMaintenanceActionsOutput) GoString 

func (s DescribePendingMaintenanceActionsOutput) 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 (*DescribePendingMaintenanceActionsOutput) SetMarker 

func (s *DescribePendingMaintenanceActionsOutput) SetMarker(v string) *DescribePendingMaintenanceActionsOutput

SetMarker sets the Marker field's value.

func (*DescribePendingMaintenanceActionsOutput) SetPendingMaintenanceActions 

func (s *DescribePendingMaintenanceActionsOutput) SetPendingMaintenanceActions(v []*ResourcePendingMaintenanceActions) *DescribePendingMaintenanceActionsOutput

SetPendingMaintenanceActions sets the PendingMaintenanceActions field's value.

func (DescribePendingMaintenanceActionsOutput) String 

func (s DescribePendingMaintenanceActionsOutput) 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 DocDB 

type DocDB struct {
	*client.Client
}

DocDB provides the API operation methods for making requests to Amazon DocumentDB with MongoDB compatibility. See this package's package overview docs for details on the service.

DocDB 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) *DocDB

New creates a new instance of the DocDB 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 DocDB client from just a session.
svc := docdb.New(mySession)

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

func (*DocDB) AddSourceIdentifierToSubscription added in v1.38.8 

func (c *DocDB) AddSourceIdentifierToSubscription(input *AddSourceIdentifierToSubscriptionInput) (*AddSourceIdentifierToSubscriptionOutput, error)

AddSourceIdentifierToSubscription API operation for Amazon DocumentDB with MongoDB compatibility.

Adds a source identifier to an existing event notification subscription.

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 with MongoDB compatibility's API operation AddSourceIdentifierToSubscription for usage and error information.

Returned Error Codes:

  • ErrCodeSubscriptionNotFoundFault "SubscriptionNotFound" The subscription name does not exist.

  • ErrCodeSourceNotFoundFault "SourceNotFound" The requested source could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/AddSourceIdentifierToSubscription

func (*DocDB) AddSourceIdentifierToSubscriptionRequest added in v1.38.8 

func (c *DocDB) AddSourceIdentifierToSubscriptionRequest(input *AddSourceIdentifierToSubscriptionInput) (req *request.Request, output *AddSourceIdentifierToSubscriptionOutput)

AddSourceIdentifierToSubscriptionRequest generates a "aws/request.Request" representing the client's request for the AddSourceIdentifierToSubscription 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 AddSourceIdentifierToSubscription for more information on using the AddSourceIdentifierToSubscription 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 AddSourceIdentifierToSubscriptionRequest method.
req, resp := client.AddSourceIdentifierToSubscriptionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/AddSourceIdentifierToSubscription

func (*DocDB) AddSourceIdentifierToSubscriptionWithContext added in v1.38.8 

func (c *DocDB) AddSourceIdentifierToSubscriptionWithContext(ctx aws.Context, input *AddSourceIdentifierToSubscriptionInput, opts ...request.Option) (*AddSourceIdentifierToSubscriptionOutput, error)

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

See AddSourceIdentifierToSubscription 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 (*DocDB) AddTagsToResource 

func (c *DocDB) AddTagsToResource(input *AddTagsToResourceInput) (*AddTagsToResourceOutput, error)

AddTagsToResource API operation for Amazon DocumentDB with MongoDB compatibility.

Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources or in a Condition statement in an Identity and Access Management (IAM) policy for Amazon DocumentDB.

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 with MongoDB compatibility's API operation AddTagsToResource for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing instance.

  • ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound" DBSnapshotIdentifier doesn't refer to an existing snapshot.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing cluster.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/AddTagsToResource

func (*DocDB) AddTagsToResourceRequest 

func (c *DocDB) AddTagsToResourceRequest(input *AddTagsToResourceInput) (req *request.Request, output *AddTagsToResourceOutput)

AddTagsToResourceRequest generates a "aws/request.Request" representing the client's request for the AddTagsToResource 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 AddTagsToResource for more information on using the AddTagsToResource 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 AddTagsToResourceRequest method.
req, resp := client.AddTagsToResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/AddTagsToResource

func (*DocDB) AddTagsToResourceWithContext 

func (c *DocDB) AddTagsToResourceWithContext(ctx aws.Context, input *AddTagsToResourceInput, opts ...request.Option) (*AddTagsToResourceOutput, error)

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

See AddTagsToResource 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 (*DocDB) ApplyPendingMaintenanceAction 

func (c *DocDB) ApplyPendingMaintenanceAction(input *ApplyPendingMaintenanceActionInput) (*ApplyPendingMaintenanceActionOutput, error)

ApplyPendingMaintenanceAction API operation for Amazon DocumentDB with MongoDB compatibility.

Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).

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 with MongoDB compatibility's API operation ApplyPendingMaintenanceAction for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundFault "ResourceNotFoundFault" The specified resource ID was not found.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The cluster isn't in a valid state.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The specified instance isn't in the available state.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ApplyPendingMaintenanceAction

func (*DocDB) ApplyPendingMaintenanceActionRequest 

func (c *DocDB) ApplyPendingMaintenanceActionRequest(input *ApplyPendingMaintenanceActionInput) (req *request.Request, output *ApplyPendingMaintenanceActionOutput)

ApplyPendingMaintenanceActionRequest generates a "aws/request.Request" representing the client's request for the ApplyPendingMaintenanceAction 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 ApplyPendingMaintenanceAction for more information on using the ApplyPendingMaintenanceAction 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 ApplyPendingMaintenanceActionRequest method.
req, resp := client.ApplyPendingMaintenanceActionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ApplyPendingMaintenanceAction

func (*DocDB) ApplyPendingMaintenanceActionWithContext 

func (c *DocDB) ApplyPendingMaintenanceActionWithContext(ctx aws.Context, input *ApplyPendingMaintenanceActionInput, opts ...request.Option) (*ApplyPendingMaintenanceActionOutput, error)

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

See ApplyPendingMaintenanceAction 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 (*DocDB) CopyDBClusterParameterGroup 

func (c *DocDB) CopyDBClusterParameterGroup(input *CopyDBClusterParameterGroupInput) (*CopyDBClusterParameterGroupOutput, error)

CopyDBClusterParameterGroup API operation for Amazon DocumentDB with MongoDB compatibility.

Copies the specified cluster parameter group.

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 with MongoDB compatibility's API operation CopyDBClusterParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing parameter group.

  • ErrCodeDBParameterGroupQuotaExceededFault "DBParameterGroupQuotaExceeded" This request would cause you to exceed the allowed number of parameter groups.

  • ErrCodeDBParameterGroupAlreadyExistsFault "DBParameterGroupAlreadyExists" A parameter group with the same name already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterParameterGroup

func (*DocDB) CopyDBClusterParameterGroupRequest 

func (c *DocDB) CopyDBClusterParameterGroupRequest(input *CopyDBClusterParameterGroupInput) (req *request.Request, output *CopyDBClusterParameterGroupOutput)

CopyDBClusterParameterGroupRequest generates a "aws/request.Request" representing the client's request for the CopyDBClusterParameterGroup 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 CopyDBClusterParameterGroup for more information on using the CopyDBClusterParameterGroup 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 CopyDBClusterParameterGroupRequest method.
req, resp := client.CopyDBClusterParameterGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterParameterGroup

func (*DocDB) CopyDBClusterParameterGroupWithContext 

func (c *DocDB) CopyDBClusterParameterGroupWithContext(ctx aws.Context, input *CopyDBClusterParameterGroupInput, opts ...request.Option) (*CopyDBClusterParameterGroupOutput, error)

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

See CopyDBClusterParameterGroup 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 (*DocDB) CopyDBClusterSnapshot 

func (c *DocDB) CopyDBClusterSnapshot(input *CopyDBClusterSnapshotInput) (*CopyDBClusterSnapshotOutput, error)

CopyDBClusterSnapshot API operation for Amazon DocumentDB with MongoDB compatibility.

Copies a snapshot of a cluster.

To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same Amazon Web Services Region.

To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.

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 with MongoDB compatibility's API operation CopyDBClusterSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterSnapshotAlreadyExistsFault "DBClusterSnapshotAlreadyExistsFault" You already have a cluster snapshot with the given identifier.

  • ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault" DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The cluster isn't in a valid state.

  • ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault" The provided value isn't a valid cluster snapshot state.

  • ErrCodeSnapshotQuotaExceededFault "SnapshotQuotaExceeded" The request would cause you to exceed the allowed number of snapshots.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred when accessing an KMS key.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterSnapshot

func (*DocDB) CopyDBClusterSnapshotRequest 

func (c *DocDB) CopyDBClusterSnapshotRequest(input *CopyDBClusterSnapshotInput) (req *request.Request, output *CopyDBClusterSnapshotOutput)

CopyDBClusterSnapshotRequest generates a "aws/request.Request" representing the client's request for the CopyDBClusterSnapshot 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 CopyDBClusterSnapshot for more information on using the CopyDBClusterSnapshot 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 CopyDBClusterSnapshotRequest method.
req, resp := client.CopyDBClusterSnapshotRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterSnapshot

func (*DocDB) CopyDBClusterSnapshotWithContext 

func (c *DocDB) CopyDBClusterSnapshotWithContext(ctx aws.Context, input *CopyDBClusterSnapshotInput, opts ...request.Option) (*CopyDBClusterSnapshotOutput, error)

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

See CopyDBClusterSnapshot 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 (*DocDB) CreateDBCluster 

func (c *DocDB) CreateDBCluster(input *CreateDBClusterInput) (*CreateDBClusterOutput, error)

CreateDBCluster API operation for Amazon DocumentDB with MongoDB compatibility.

Creates a new Amazon DocumentDB 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 with MongoDB compatibility's API operation CreateDBCluster for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterAlreadyExistsFault "DBClusterAlreadyExistsFault" You already have a cluster with the given identifier.

  • ErrCodeInsufficientStorageClusterCapacityFault "InsufficientStorageClusterCapacity" There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

  • ErrCodeDBClusterQuotaExceededFault "DBClusterQuotaExceededFault" The cluster can't be created because you have reached the maximum allowed quota of clusters.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would cause you to exceed the allowed amount of storage available across all instances.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing subnet group.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The cluster isn't in a valid state.

  • ErrCodeInvalidDBSubnetGroupStateFault "InvalidDBSubnetGroupStateFault" The subnet group can't be deleted because it's in use.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The specified instance isn't in the available state.

  • ErrCodeDBClusterParameterGroupNotFoundFault "DBClusterParameterGroupNotFound" DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred when accessing an KMS key.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing cluster.

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing instance.

  • ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs "DBSubnetGroupDoesNotCoverEnoughAZs" Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

  • ErrCodeGlobalClusterNotFoundFault "GlobalClusterNotFoundFault" The GlobalClusterIdentifier doesn't refer to an existing global cluster.

  • ErrCodeInvalidGlobalClusterStateFault "InvalidGlobalClusterStateFault" The requested operation can't be performed while the cluster is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBCluster

func (*DocDB) CreateDBClusterParameterGroup 

func (c *DocDB) CreateDBClusterParameterGroup(input *CreateDBClusterParameterGroupInput) (*CreateDBClusterParameterGroupOutput, error)

CreateDBClusterParameterGroup API operation for Amazon DocumentDB with MongoDB compatibility.

Creates a new cluster parameter group.

Parameters in a cluster parameter group apply to all of the instances in a cluster.

A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group (https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-create.html) or copy an existing parameter group (https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html), modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups (https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html).

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 with MongoDB compatibility's API operation CreateDBClusterParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeDBParameterGroupQuotaExceededFault "DBParameterGroupQuotaExceeded" This request would cause you to exceed the allowed number of parameter groups.

  • ErrCodeDBParameterGroupAlreadyExistsFault "DBParameterGroupAlreadyExists" A parameter group with the same name already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterParameterGroup

func (*DocDB) CreateDBClusterParameterGroupRequest 

func (c *DocDB) CreateDBClusterParameterGroupRequest(input *CreateDBClusterParameterGroupInput) (req *request.Request, output *CreateDBClusterParameterGroupOutput)

CreateDBClusterParameterGroupRequest generates a "aws/request.Request" representing the client's request for the CreateDBClusterParameterGroup 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 CreateDBClusterParameterGroup for more information on using the CreateDBClusterParameterGroup 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 CreateDBClusterParameterGroupRequest method.
req, resp := client.CreateDBClusterParameterGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterParameterGroup

func (*DocDB) CreateDBClusterParameterGroupWithContext 

func (c *DocDB) CreateDBClusterParameterGroupWithContext(ctx aws.Context, input *CreateDBClusterParameterGroupInput, opts ...request.Option) (*CreateDBClusterParameterGroupOutput, error)

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

See CreateDBClusterParameterGroup 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 (*DocDB) CreateDBClusterRequest 

func (c *DocDB) CreateDBClusterRequest(input *CreateDBClusterInput) (req *request.Request, output *CreateDBClusterOutput)

CreateDBClusterRequest generates a "aws/request.Request" representing the client's request for the CreateDBCluster 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 CreateDBCluster for more information on using the CreateDBCluster 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 CreateDBClusterRequest method.
req, resp := client.CreateDBClusterRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBCluster

func (*DocDB) CreateDBClusterSnapshot 

func (c *DocDB) CreateDBClusterSnapshot(input *CreateDBClusterSnapshotInput) (*CreateDBClusterSnapshotOutput, error)

CreateDBClusterSnapshot API operation for Amazon DocumentDB with MongoDB compatibility.

Creates a snapshot of a 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 with MongoDB compatibility's API operation CreateDBClusterSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterSnapshotAlreadyExistsFault "DBClusterSnapshotAlreadyExistsFault" You already have a cluster snapshot with the given identifier.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The cluster isn't in a valid state.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing cluster.

  • ErrCodeSnapshotQuotaExceededFault "SnapshotQuotaExceeded" The request would cause you to exceed the allowed number of snapshots.

  • ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault" The provided value isn't a valid cluster snapshot state.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterSnapshot

func (*DocDB) CreateDBClusterSnapshotRequest 

func (c *DocDB) CreateDBClusterSnapshotRequest(input *CreateDBClusterSnapshotInput) (req *request.Request, output *CreateDBClusterSnapshotOutput)

CreateDBClusterSnapshotRequest generates a "aws/request.Request" representing the client's request for the CreateDBClusterSnapshot 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 CreateDBClusterSnapshot for more information on using the CreateDBClusterSnapshot 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 CreateDBClusterSnapshotRequest method.
req, resp := client.CreateDBClusterSnapshotRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterSnapshot

func (*DocDB) CreateDBClusterSnapshotWithContext 

func (c *DocDB) CreateDBClusterSnapshotWithContext(ctx aws.Context, input *CreateDBClusterSnapshotInput, opts ...request.Option) (*CreateDBClusterSnapshotOutput, error)

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

See CreateDBClusterSnapshot 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 (*DocDB) CreateDBClusterWithContext 

func (c *DocDB) CreateDBClusterWithContext(ctx aws.Context, input *CreateDBClusterInput, opts ...request.Option) (*CreateDBClusterOutput, error)

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

See CreateDBCluster 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 (*DocDB) CreateDBInstance 

func (c *DocDB) CreateDBInstance(input *CreateDBInstanceInput) (*CreateDBInstanceOutput, error)

CreateDBInstance API operation for Amazon DocumentDB with MongoDB compatibility.

Creates a new instance.

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 with MongoDB compatibility's API operation CreateDBInstance for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceAlreadyExistsFault "DBInstanceAlreadyExists" You already have a instance with the given identifier.

  • ErrCodeInsufficientDBInstanceCapacityFault "InsufficientDBInstanceCapacity" The specified instance class isn't available in the specified Availability Zone.

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing parameter group.

  • ErrCodeDBSecurityGroupNotFoundFault "DBSecurityGroupNotFound" DBSecurityGroupName doesn't refer to an existing security group.

  • ErrCodeInstanceQuotaExceededFault "InstanceQuotaExceeded" The request would cause you to exceed the allowed number of instances.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would cause you to exceed the allowed amount of storage available across all instances.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing subnet group.

  • ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs "DBSubnetGroupDoesNotCoverEnoughAZs" Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The cluster isn't in a valid state.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing cluster.

  • ErrCodeStorageTypeNotSupportedFault "StorageTypeNotSupported" Storage of the specified StorageType can't be associated with the DB instance.

  • ErrCodeAuthorizationNotFoundFault "AuthorizationNotFound" The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.

    Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred when accessing an KMS key.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBInstance

func (*DocDB) CreateDBInstanceRequest 

func (c *DocDB) CreateDBInstanceRequest(input *CreateDBInstanceInput) (req *request.Request, output *CreateDBInstanceOutput)

CreateDBInstanceRequest generates a "aws/request.Request" representing the client's request for the CreateDBInstance 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 CreateDBInstance for more information on using the CreateDBInstance 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 CreateDBInstanceRequest method.
req, resp := client.CreateDBInstanceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBInstance

func (*DocDB) CreateDBInstanceWithContext 

func (c *DocDB) CreateDBInstanceWithContext(ctx aws.Context, input *CreateDBInstanceInput, opts ...request.Option) (*CreateDBInstanceOutput, error)

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

See CreateDBInstance 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 (*DocDB) CreateDBSubnetGroup 

func (c *DocDB) CreateDBSubnetGroup(input *CreateDBSubnetGroupInput) (*CreateDBSubnetGroupOutput, error)

CreateDBSubnetGroup API operation for Amazon DocumentDB with MongoDB compatibility.

Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.

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 with MongoDB compatibility's API operation CreateDBSubnetGroup for usage and error information.

Returned Error Codes:

  • ErrCodeDBSubnetGroupAlreadyExistsFault "DBSubnetGroupAlreadyExists" DBSubnetGroupName is already being used by an existing subnet group.

  • ErrCodeDBSubnetGroupQuotaExceededFault "DBSubnetGroupQuotaExceeded" The request would cause you to exceed the allowed number of subnet groups.

  • ErrCodeDBSubnetQuotaExceededFault "DBSubnetQuotaExceededFault" The request would cause you to exceed the allowed number of subnets in a subnet group.

  • ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs "DBSubnetGroupDoesNotCoverEnoughAZs" Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBSubnetGroup

func (*DocDB) CreateDBSubnetGroupRequest 

func (c *DocDB) CreateDBSubnetGroupRequest(input *CreateDBSubnetGroupInput) (req *request.Request, output *CreateDBSubnetGroupOutput)

CreateDBSubnetGroupRequest generates a "aws/request.Request" representing the client's request for the CreateDBSubnetGroup 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 CreateDBSubnetGroup for more information on using the CreateDBSubnetGroup 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 CreateDBSubnetGroupRequest method.
req, resp := client.CreateDBSubnetGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBSubnetGroup

func (*DocDB) CreateDBSubnetGroupWithContext 

func (c *DocDB) CreateDBSubnetGroupWithContext(ctx aws.Context, input *CreateDBSubnetGroupInput, opts ...request.Option) (*CreateDBSubnetGroupOutput, error)

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

See CreateDBSubnetGroup 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 (*DocDB) CreateEventSubscription added in v1.38.8 

func (c *DocDB) CreateEventSubscription(input *CreateEventSubscriptionInput) (*CreateEventSubscriptionOutput, error)

CreateEventSubscription API operation for Amazon DocumentDB with MongoDB compatibility.

Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.

You can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.

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 with MongoDB compatibility's API operation CreateEventSubscription for usage and error information.

Returned Error Codes:

  • ErrCodeEventSubscriptionQuotaExceededFault "EventSubscriptionQuotaExceeded" You have reached the maximum number of event subscriptions.

  • ErrCodeSubscriptionAlreadyExistFault "SubscriptionAlreadyExist" The provided subscription name already exists.

  • ErrCodeSNSInvalidTopicFault "SNSInvalidTopic" Amazon SNS has responded that there is a problem with the specified topic.

  • ErrCodeSNSNoAuthorizationFault "SNSNoAuthorization" You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).

  • ErrCodeSNSTopicArnNotFoundFault "SNSTopicArnNotFound" The SNS topic Amazon Resource Name (ARN) does not exist.

  • ErrCodeSubscriptionCategoryNotFoundFault "SubscriptionCategoryNotFound" The provided category does not exist.

  • ErrCodeSourceNotFoundFault "SourceNotFound" The requested source could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateEventSubscription

func (*DocDB) CreateEventSubscriptionRequest added in v1.38.8 

func (c *DocDB) CreateEventSubscriptionRequest(input *CreateEventSubscriptionInput) (req *request.Request, output *CreateEventSubscriptionOutput)

CreateEventSubscriptionRequest generates a "aws/request.Request" representing the client's request for the CreateEventSubscription 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 CreateEventSubscription for more information on using the CreateEventSubscription 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 CreateEventSubscriptionRequest method.
req, resp := client.CreateEventSubscriptionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateEventSubscription

func (*DocDB) CreateEventSubscriptionWithContext added in v1.38.8 

func (c *DocDB) CreateEventSubscriptionWithContext(ctx aws.Context, input *CreateEventSubscriptionInput, opts ...request.Option) (*CreateEventSubscriptionOutput, error)

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

See CreateEventSubscription 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 (*DocDB) CreateGlobalCluster added in v1.38.53 

func (c *DocDB) CreateGlobalCluster(input *CreateGlobalClusterInput) (*CreateGlobalClusterOutput, error)

CreateGlobalCluster API operation for Amazon DocumentDB with MongoDB compatibility.

Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.

You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.

This action only applies to Amazon DocumentDB 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 with MongoDB compatibility's API operation CreateGlobalCluster for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalClusterAlreadyExistsFault "GlobalClusterAlreadyExistsFault" The GlobalClusterIdentifier already exists. Choose a new global cluster identifier (unique name) to create a new global cluster.

  • ErrCodeGlobalClusterQuotaExceededFault "GlobalClusterQuotaExceededFault" The number of global clusters for this account is already at the maximum allowed.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The cluster isn't in a valid state.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing cluster.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateGlobalCluster

func (*DocDB) CreateGlobalClusterRequest added in v1.38.53 

func (c *DocDB) CreateGlobalClusterRequest(input *CreateGlobalClusterInput) (req *request.Request, output *CreateGlobalClusterOutput)

CreateGlobalClusterRequest generates a "aws/request.Request" representing the client's request for the CreateGlobalCluster 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 CreateGlobalCluster for more information on using the CreateGlobalCluster 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 CreateGlobalClusterRequest method.
req, resp := client.CreateGlobalClusterRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateGlobalCluster

func (*DocDB) CreateGlobalClusterWithContext added in v1.38.53 

func (c *DocDB) CreateGlobalClusterWithContext(ctx aws.Context, input *CreateGlobalClusterInput, opts ...request.Option) (*CreateGlobalClusterOutput, error)

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

See CreateGlobalCluster 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 (*DocDB) DeleteDBCluster 

func (c *DocDB) DeleteDBCluster(input *DeleteDBClusterInput) (*DeleteDBClusterOutput, error)

DeleteDBCluster API operation for Amazon DocumentDB with MongoDB compatibility.

Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.

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 with MongoDB compatibility's API operation DeleteDBCluster for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing cluster.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The cluster isn't in a valid state.

  • ErrCodeDBClusterSnapshotAlreadyExistsFault "DBClusterSnapshotAlreadyExistsFault" You already have a cluster snapshot with the given identifier.

  • ErrCodeSnapshotQuotaExceededFault "SnapshotQuotaExceeded" The request would cause you to exceed the allowed number of snapshots.

  • ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault" The provided value isn't a valid cluster snapshot state.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBCluster

func (*DocDB) DeleteDBClusterParameterGroup 

func (c *DocDB) DeleteDBClusterParameterGroup(input *DeleteDBClusterParameterGroupInput) (*DeleteDBClusterParameterGroupOutput, error)

DeleteDBClusterParameterGroup API operation for Amazon DocumentDB with MongoDB compatibility.

Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any 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 with MongoDB compatibility's API operation DeleteDBClusterParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBParameterGroupStateFault "InvalidDBParameterGroupState" The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing parameter group.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterParameterGroup

func (*DocDB) DeleteDBClusterParameterGroupRequest 

func (c *DocDB) DeleteDBClusterParameterGroupRequest(input *DeleteDBClusterParameterGroupInput) (req *request.Request, output *DeleteDBClusterParameterGroupOutput)

DeleteDBClusterParameterGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteDBClusterParameterGroup 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 DeleteDBClusterParameterGroup for more information on using the DeleteDBClusterParameterGroup 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 DeleteDBClusterParameterGroupRequest method.
req, resp := client.DeleteDBClusterParameterGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterParameterGroup

func (*DocDB) DeleteDBClusterParameterGroupWithContext 

func (c *DocDB) DeleteDBClusterParameterGroupWithContext(ctx aws.Context, input *DeleteDBClusterParameterGroupInput, opts ...request.Option) (*DeleteDBClusterParameterGroupOutput, error)

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

See DeleteDBClusterParameterGroup 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 (*DocDB) DeleteDBClusterRequest 

func (c *DocDB) DeleteDBClusterRequest(input *DeleteDBClusterInput) (req *request.Request, output *DeleteDBClusterOutput)

DeleteDBClusterRequest generates a "aws/request.Request" representing the client's request for the DeleteDBCluster 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 DeleteDBCluster for more information on using the DeleteDBCluster 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 DeleteDBClusterRequest method.
req, resp := client.DeleteDBClusterRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBCluster

func (*DocDB) DeleteDBClusterSnapshot 

func (c *DocDB) DeleteDBClusterSnapshot(input *DeleteDBClusterSnapshotInput) (*DeleteDBClusterSnapshotOutput, error)

DeleteDBClusterSnapshot API operation for Amazon DocumentDB with MongoDB compatibility.

Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The cluster snapshot must be in the available state to be deleted.

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 with MongoDB compatibility's API operation DeleteDBClusterSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault" The provided value isn't a valid cluster snapshot state.

  • ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault" DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterSnapshot

func (*DocDB) DeleteDBClusterSnapshotRequest 

func (c *DocDB) DeleteDBClusterSnapshotRequest(input *DeleteDBClusterSnapshotInput) (req *request.Request, output *DeleteDBClusterSnapshotOutput)

DeleteDBClusterSnapshotRequest generates a "aws/request.Request" representing the client's request for the DeleteDBClusterSnapshot 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 DeleteDBClusterSnapshot for more information on using the DeleteDBClusterSnapshot 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 DeleteDBClusterSnapshotRequest method.
req, resp := client.DeleteDBClusterSnapshotRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterSnapshot

func (*DocDB) DeleteDBClusterSnapshotWithContext 

func (c *DocDB) DeleteDBClusterSnapshotWithContext(ctx aws.Context, input *DeleteDBClusterSnapshotInput, opts ...request.Option) (*DeleteDBClusterSnapshotOutput, error)

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

See DeleteDBClusterSnapshot 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 (*DocDB) DeleteDBClusterWithContext 

func (c *DocDB) DeleteDBClusterWithContext(ctx aws.Context, input *DeleteDBClusterInput, opts ...request.Option) (*DeleteDBClusterOutput, error)

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

See DeleteDBCluster 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 (*DocDB) DeleteDBInstance 

func (c *DocDB) DeleteDBInstance(input *DeleteDBInstanceInput) (*DeleteDBInstanceOutput, error)

DeleteDBInstance API operation for Amazon DocumentDB with MongoDB compatibility.

Deletes a previously provisioned instance.

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 with MongoDB compatibility's API operation DeleteDBInstance for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing instance.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The specified instance isn't in the available state.

  • ErrCodeDBSnapshotAlreadyExistsFault "DBSnapshotAlreadyExists" DBSnapshotIdentifier is already being used by an existing snapshot.

  • ErrCodeSnapshotQuotaExceededFault "SnapshotQuotaExceeded" The request would cause you to exceed the allowed number of snapshots.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The cluster isn't in a valid state.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBInstance

func (*DocDB) DeleteDBInstanceRequest 

func (c *DocDB) DeleteDBInstanceRequest(input *DeleteDBInstanceInput) (req *request.Request, output *DeleteDBInstanceOutput)

DeleteDBInstanceRequest generates a "aws/request.Request" representing the client's request for the DeleteDBInstance 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 DeleteDBInstance for more information on using the DeleteDBInstance 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 DeleteDBInstanceRequest method.
req, resp := client.DeleteDBInstanceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBInstance

func (*DocDB) DeleteDBInstanceWithContext 

func (c *DocDB) DeleteDBInstanceWithContext(ctx aws.Context, input *DeleteDBInstanceInput, opts ...request.Option) (*DeleteDBInstanceOutput, error)

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

See DeleteDBInstance 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 (*DocDB) DeleteDBSubnetGroup 

func (c *DocDB) DeleteDBSubnetGroup(input *DeleteDBSubnetGroupInput) (*DeleteDBSubnetGroupOutput, error)

DeleteDBSubnetGroup API operation for Amazon DocumentDB with MongoDB compatibility.

Deletes a subnet group.

The specified database subnet group must not be associated with any DB instances.

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 with MongoDB compatibility's API operation DeleteDBSubnetGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBSubnetGroupStateFault "InvalidDBSubnetGroupStateFault" The subnet group can't be deleted because it's in use.

  • ErrCodeInvalidDBSubnetStateFault "InvalidDBSubnetStateFault" The subnet isn't in the available state.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing subnet group.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBSubnetGroup

func (*DocDB) DeleteDBSubnetGroupRequest 

func (c *DocDB) DeleteDBSubnetGroupRequest(input *DeleteDBSubnetGroupInput) (req *request.Request, output *DeleteDBSubnetGroupOutput)

DeleteDBSubnetGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteDBSubnetGroup 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 DeleteDBSubnetGroup for more information on using the DeleteDBSubnetGroup 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 DeleteDBSubnetGroupRequest method.
req, resp := client.DeleteDBSubnetGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBSubnetGroup

func (*DocDB) DeleteDBSubnetGroupWithContext 

func (c *DocDB) DeleteDBSubnetGroupWithContext(ctx aws.Context, input *DeleteDBSubnetGroupInput, opts ...request.Option) (*DeleteDBSubnetGroupOutput, error)

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

See DeleteDBSubnetGroup 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 (*DocDB) DeleteEventSubscription added in v1.38.8 

func (c *DocDB) DeleteEventSubscription(input *DeleteEventSubscriptionInput) (*DeleteEventSubscriptionOutput, error)

DeleteEventSubscription API operation for Amazon DocumentDB with MongoDB compatibility.

Deletes an Amazon DocumentDB event notification subscription.

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 with MongoDB compatibility's API operation DeleteEventSubscription for usage and error information.

Returned Error Codes:

  • ErrCodeSubscriptionNotFoundFault "SubscriptionNotFound" The subscription name does not exist.

  • ErrCodeInvalidEventSubscriptionStateFault "InvalidEventSubscriptionState" Someone else might be modifying a subscription. Wait a few seconds, and try again.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteEventSubscription

func (*DocDB) DeleteEventSubscriptionRequest added in v1.38.8 

func (c *DocDB) DeleteEventSubscriptionRequest(input *DeleteEventSubscriptionInput) (req *request.Request, output *DeleteEventSubscriptionOutput)

DeleteEventSubscriptionRequest generates a "aws/request.Request" representing the client's request for the DeleteEventSubscription 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 DeleteEventSubscription for more information on using the DeleteEventSubscription 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 DeleteEventSubscriptionRequest method.
req, resp := client.DeleteEventSubscriptionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteEventSubscription

func (*DocDB) DeleteEventSubscriptionWithContext added in v1.38.8 

func (c *DocDB) DeleteEventSubscriptionWithContext(ctx aws.Context, input *DeleteEventSubscriptionInput, opts ...request.Option) (*DeleteEventSubscriptionOutput, error)

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

See DeleteEventSubscription 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 (*DocDB) DeleteGlobalCluster added in v1.38.53 

func (c *DocDB) DeleteGlobalCluster(input *DeleteGlobalClusterInput) (*DeleteGlobalClusterOutput, error)

DeleteGlobalCluster API operation for Amazon DocumentDB with MongoDB compatibility.

Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.

This action only applies to Amazon DocumentDB 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 with MongoDB compatibility's API operation DeleteGlobalCluster for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalClusterNotFoundFault "GlobalClusterNotFoundFault" The GlobalClusterIdentifier doesn't refer to an existing global cluster.

  • ErrCodeInvalidGlobalClusterStateFault "InvalidGlobalClusterStateFault" The requested operation can't be performed while the cluster is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteGlobalCluster

func (*DocDB) DeleteGlobalClusterRequest added in v1.38.53 

func (c *DocDB) DeleteGlobalClusterRequest(input *DeleteGlobalClusterInput) (req *request.Request, output *DeleteGlobalClusterOutput)

DeleteGlobalClusterRequest generates a "aws/request.Request" representing the client's request for the DeleteGlobalCluster 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 DeleteGlobalCluster for more information on using the DeleteGlobalCluster 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 DeleteGlobalClusterRequest method.
req, resp := client.DeleteGlobalClusterRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteGlobalCluster

func (*DocDB) DeleteGlobalClusterWithContext added in v1.38.53 

func (c *DocDB) DeleteGlobalClusterWithContext(ctx aws.Context, input *DeleteGlobalClusterInput, opts ...request.Option) (*DeleteGlobalClusterOutput, error)

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

See DeleteGlobalCluster 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 (*DocDB) DescribeCertificates added in v1.25.3 

func (c *DocDB) DescribeCertificates(input *DescribeCertificatesInput) (*DescribeCertificatesOutput, error)

DescribeCertificates API operation for Amazon DocumentDB with MongoDB compatibility.

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.

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 with MongoDB compatibility's API operation DescribeCertificates for usage and error information.

Returned Error Codes:

  • ErrCodeCertificateNotFoundFault "CertificateNotFound" CertificateIdentifier doesn't refer to an existing certificate.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeCertificates

func (*DocDB) DescribeCertificatesPages added in v1.34.23 

func (c *DocDB) DescribeCertificatesPages(input *DescribeCertificatesInput, fn func(*DescribeCertificatesOutput, bool) bool) error

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

See DescribeCertificates 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 DescribeCertificates operation.
pageNum := 0
err := client.DescribeCertificatesPages(params,
    func(page *docdb.DescribeCertificatesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DocDB) DescribeCertificatesPagesWithContext added in v1.34.23 

func (c *DocDB) DescribeCertificatesPagesWithContext(ctx aws.Context, input *DescribeCertificatesInput, fn func(*DescribeCertificatesOutput, bool) bool, opts ...request.Option) error

DescribeCertificatesPagesWithContext same as DescribeCertificatesPages 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 (*DocDB) DescribeCertificatesRequest added in v1.25.3 

func (c *DocDB) DescribeCertificatesRequest(input *DescribeCertificatesInput) (req *request.Request, output *DescribeCertificatesOutput)

DescribeCertificatesRequest generates a "aws/request.Request" representing the client's request for the DescribeCertificates 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 DescribeCertificates for more information on using the DescribeCertificates 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 DescribeCertificatesRequest method.
req, resp := client.DescribeCertificatesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeCertificates

func (*DocDB) DescribeCertificatesWithContext added in v1.25.3 

func (c *DocDB) DescribeCertificatesWithContext(ctx aws.Context, input *DescribeCertificatesInput, opts ...request.Option) (*DescribeCertificatesOutput, error)

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

See DescribeCertificates 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 (*DocDB) DescribeDBClusterParameterGroups 

func (c *DocDB) DescribeDBClusterParameterGroups(input *DescribeDBClusterParameterGroupsInput) (*DescribeDBClusterParameterGroupsOutput, error)

DescribeDBClusterParameterGroups API operation for Amazon DocumentDB with MongoDB compatibility.

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.

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 with MongoDB compatibility's API operation DescribeDBClusterParameterGroups for usage and error information.

Returned Error Codes:

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing parameter group.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterParameterGroups

func (*DocDB) DescribeDBClusterParameterGroupsPages added in v1.34.23 

func (c *DocDB) DescribeDBClusterParameterGroupsPages(input *DescribeDBClusterParameterGroupsInput, fn func(*DescribeDBClusterParameterGroupsOutput, bool) bool) error

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

See DescribeDBClusterParameterGroups 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 DescribeDBClusterParameterGroups operation.
pageNum := 0
err := client.DescribeDBClusterParameterGroupsPages(params,
    func(page *docdb.DescribeDBClusterParameterGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DocDB) DescribeDBClusterParameterGroupsPagesWithContext added in v1.34.23 

func (c *DocDB) DescribeDBClusterParameterGroupsPagesWithContext(ctx aws.Context, input *DescribeDBClusterParameterGroupsInput, fn func(*DescribeDBClusterParameterGroupsOutput, bool) bool, opts ...request.Option) error

DescribeDBClusterParameterGroupsPagesWithContext same as DescribeDBClusterParameterGroupsPages 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 (*DocDB) DescribeDBClusterParameterGroupsRequest 

func (c *DocDB) DescribeDBClusterParameterGroupsRequest(input *DescribeDBClusterParameterGroupsInput) (req *request.Request, output *DescribeDBClusterParameterGroupsOutput)

DescribeDBClusterParameterGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeDBClusterParameterGroups 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 DescribeDBClusterParameterGroups for more information on using the DescribeDBClusterParameterGroups 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 DescribeDBClusterParameterGroupsRequest method.
req, resp := client.DescribeDBClusterParameterGroupsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterParameterGroups

func (*DocDB) DescribeDBClusterParameterGroupsWithContext 

func (c *DocDB) DescribeDBClusterParameterGroupsWithContext(ctx aws.Context, input *DescribeDBClusterParameterGroupsInput, opts ...request.Option) (*DescribeDBClusterParameterGroupsOutput, error)

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

See DescribeDBClusterParameterGroups 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 (*DocDB) DescribeDBClusterParameters 

func (c *DocDB) DescribeDBClusterParameters(input *DescribeDBClusterParametersInput) (*DescribeDBClusterParametersOutput, error)

DescribeDBClusterParameters API operation for Amazon DocumentDB with MongoDB compatibility.

Returns the detailed parameter list for a particular cluster parameter group.

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 with MongoDB compatibility's API operation DescribeDBClusterParameters for usage and error information.

Returned Error Codes:

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing parameter group.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterParameters

func (*DocDB) DescribeDBClusterParametersPages added in v1.34.23 

func (c *DocDB) DescribeDBClusterParametersPages(input *DescribeDBClusterParametersInput, fn func(*DescribeDBClusterParametersOutput, bool) bool) error

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

See DescribeDBClusterParameters 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 DescribeDBClusterParameters operation.
pageNum := 0
err := client.DescribeDBClusterParametersPages(params,
    func(page *docdb.DescribeDBClusterParametersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DocDB) DescribeDBClusterParametersPagesWithContext added in v1.34.23 

func (c *DocDB) DescribeDBClusterParametersPagesWithContext(ctx aws.Context, input *DescribeDBClusterParametersInput, fn func(*DescribeDBClusterParametersOutput, bool) bool, opts ...request.Option) error

DescribeDBClusterParametersPagesWithContext same as DescribeDBClusterParametersPages 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 (*DocDB) DescribeDBClusterParametersRequest 

func (c *DocDB) DescribeDBClusterParametersRequest(input *DescribeDBClusterParametersInput) (req *request.Request, output *DescribeDBClusterParametersOutput)

DescribeDBClusterParametersRequest generates a "aws/request.Request" representing the client's request for the DescribeDBClusterParameters 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 DescribeDBClusterParameters for more information on using the DescribeDBClusterParameters 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 DescribeDBClusterParametersRequest method.
req, resp := client.DescribeDBClusterParametersRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterParameters

func (*DocDB) DescribeDBClusterParametersWithContext 

func (c *DocDB) DescribeDBClusterParametersWithContext(ctx aws.Context, input *DescribeDBClusterParametersInput, opts ...request.Option) (*DescribeDBClusterParametersOutput, error)

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

See DescribeDBClusterParameters 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 (*DocDB) DescribeDBClusterSnapshotAttributes 

func (c *DocDB) DescribeDBClusterSnapshotAttributes(input *DescribeDBClusterSnapshotAttributesInput) (*DescribeDBClusterSnapshotAttributesOutput, error)

DescribeDBClusterSnapshotAttributes API operation for Amazon DocumentDB with MongoDB compatibility.

Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.

When you share snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.

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 with MongoDB compatibility's API operation DescribeDBClusterSnapshotAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault" DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes

func (*DocDB) DescribeDBClusterSnapshotAttributesRequest 

func (c *DocDB) DescribeDBClusterSnapshotAttributesRequest(input *DescribeDBClusterSnapshotAttributesInput) (req *request.Request, output *DescribeDBClusterSnapshotAttributesOutput)

DescribeDBClusterSnapshotAttributesRequest generates a "aws/request.Request" representing the client's request for the DescribeDBClusterSnapshotAttributes 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 DescribeDBClusterSnapshotAttributes for more information on using the DescribeDBClusterSnapshotAttributes 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 DescribeDBClusterSnapshotAttributesRequest method.
req, resp := client.DescribeDBClusterSnapshotAttributesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes

func (*DocDB) DescribeDBClusterSnapshotAttributesWithContext 

func (c *DocDB) DescribeDBClusterSnapshotAttributesWithContext(ctx aws.Context, input *DescribeDBClusterSnapshotAttributesInput, opts ...request.Option) (*DescribeDBClusterSnapshotAttributesOutput, error)

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

See DescribeDBClusterSnapshotAttributes 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 (*DocDB) DescribeDBClusterSnapshots 

func (c *DocDB) DescribeDBClusterSnapshots(input *DescribeDBClusterSnapshotsInput) (*DescribeDBClusterSnapshotsOutput, error)

DescribeDBClusterSnapshots API operation for Amazon DocumentDB with MongoDB compatibility.

Returns information about cluster snapshots. This API operation supports pagination.

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 with MongoDB compatibility's API operation DescribeDBClusterSnapshots for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault" DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshots

func (*DocDB) DescribeDBClusterSnapshotsPages added in v1.34.23 

func (c *DocDB) DescribeDBClusterSnapshotsPages(input *DescribeDBClusterSnapshotsInput, fn func(*DescribeDBClusterSnapshotsOutput, bool) bool) error

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

See DescribeDBClusterSnapshots 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 DescribeDBClusterSnapshots operation.
pageNum := 0
err := client.DescribeDBClusterSnapshotsPages(params,
    func(page *docdb.DescribeDBClusterSnapshotsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DocDB) DescribeDBClusterSnapshotsPagesWithContext added in v1.34.23 

func (c *DocDB) DescribeDBClusterSnapshotsPagesWithContext(ctx aws.Context, input *DescribeDBClusterSnapshotsInput, fn func(*DescribeDBClusterSnapshotsOutput, bool) bool, opts ...request.Option) error

DescribeDBClusterSnapshotsPagesWithContext same as DescribeDBClusterSnapshotsPages 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 (*DocDB) DescribeDBClusterSnapshotsRequest 

func (c *DocDB) DescribeDBClusterSnapshotsRequest(input *DescribeDBClusterSnapshotsInput) (req *request.Request, output *DescribeDBClusterSnapshotsOutput)

DescribeDBClusterSnapshotsRequest generates a "aws/request.Request" representing the client's request for the DescribeDBClusterSnapshots 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 DescribeDBClusterSnapshots for more information on using the DescribeDBClusterSnapshots 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 DescribeDBClusterSnapshotsRequest method.
req, resp := client.DescribeDBClusterSnapshotsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshots

func (*DocDB) DescribeDBClusterSnapshotsWithContext 

func (c *DocDB) DescribeDBClusterSnapshotsWithContext(ctx aws.Context, input *DescribeDBClusterSnapshotsInput, opts ...request.Option) (*DescribeDBClusterSnapshotsOutput, error)

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

See DescribeDBClusterSnapshots 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 (*DocDB) DescribeDBClusters 

func (c *DocDB) DescribeDBClusters(input *DescribeDBClustersInput) (*DescribeDBClustersOutput, error)

DescribeDBClusters API operation for Amazon DocumentDB with MongoDB compatibility.

Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB 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 with MongoDB compatibility's API operation DescribeDBClusters for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing cluster.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusters

func (*DocDB) DescribeDBClustersPages 

func (c *DocDB) DescribeDBClustersPages(input *DescribeDBClustersInput, fn func(*DescribeDBClustersOutput, bool) bool) error

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

See DescribeDBClusters 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 DescribeDBClusters operation.
pageNum := 0
err := client.DescribeDBClustersPages(params,
    func(page *docdb.DescribeDBClustersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DocDB) DescribeDBClustersPagesWithContext 

func (c *DocDB) DescribeDBClustersPagesWithContext(ctx aws.Context, input *DescribeDBClustersInput, fn func(*DescribeDBClustersOutput, bool) bool, opts ...request.Option) error

DescribeDBClustersPagesWithContext same as DescribeDBClustersPages 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 (*DocDB) DescribeDBClustersRequest 

func (c *DocDB) DescribeDBClustersRequest(input *DescribeDBClustersInput) (req *request.Request, output *DescribeDBClustersOutput)

DescribeDBClustersRequest generates a "aws/request.Request" representing the client's request for the DescribeDBClusters 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 DescribeDBClusters for more information on using the DescribeDBClusters 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 DescribeDBClustersRequest method.
req, resp := client.DescribeDBClustersRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusters

func (*DocDB) DescribeDBClustersWithContext 

func (c *DocDB) DescribeDBClustersWithContext(ctx aws.Context, input *DescribeDBClustersInput, opts ...request.Option) (*DescribeDBClustersOutput, error)

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

See DescribeDBClusters 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 (*DocDB) DescribeDBEngineVersions 

func (c *DocDB) DescribeDBEngineVersions(input *DescribeDBEngineVersionsInput) (*DescribeDBEngineVersionsOutput, error)

DescribeDBEngineVersions API operation for Amazon DocumentDB with MongoDB compatibility.

Returns a list of the available engines.

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 with MongoDB compatibility's API operation DescribeDBEngineVersions for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBEngineVersions

func (*DocDB) DescribeDBEngineVersionsPages 

func (c *DocDB) DescribeDBEngineVersionsPages(input *DescribeDBEngineVersionsInput, fn func(*DescribeDBEngineVersionsOutput, bool) bool) error

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

See DescribeDBEngineVersions 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 DescribeDBEngineVersions operation.
pageNum := 0
err := client.DescribeDBEngineVersionsPages(params,
    func(page *docdb.DescribeDBEngineVersionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DocDB) DescribeDBEngineVersionsPagesWithContext 

func (c *DocDB) DescribeDBEngineVersionsPagesWithContext(ctx aws.Context, input *DescribeDBEngineVersionsInput, fn func(*DescribeDBEngineVersionsOutput, bool) bool, opts ...request.Option) error

DescribeDBEngineVersionsPagesWithContext same as DescribeDBEngineVersionsPages 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 (*DocDB) DescribeDBEngineVersionsRequest 

func (c *DocDB) DescribeDBEngineVersionsRequest(input *DescribeDBEngineVersionsInput) (req *request.Request, output *DescribeDBEngineVersionsOutput)

DescribeDBEngineVersionsRequest generates a "aws/request.Request" representing the client's request for the DescribeDBEngineVersions 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 DescribeDBEngineVersions for more information on using the DescribeDBEngineVersions 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 DescribeDBEngineVersionsRequest method.
req, resp := client.DescribeDBEngineVersionsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBEngineVersions

func (*DocDB) DescribeDBEngineVersionsWithContext 

func (c *DocDB) DescribeDBEngineVersionsWithContext(ctx aws.Context, input *DescribeDBEngineVersionsInput, opts ...request.Option) (*DescribeDBEngineVersionsOutput, error)

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

See DescribeDBEngineVersions 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 (*DocDB) DescribeDBInstances 

func (c *DocDB) DescribeDBInstances(input *DescribeDBInstancesInput) (*DescribeDBInstancesOutput, error)

DescribeDBInstances API operation for Amazon DocumentDB with MongoDB compatibility.

Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.

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 with MongoDB compatibility's API operation DescribeDBInstances for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing instance.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBInstances

func (*DocDB) DescribeDBInstancesPages 

func (c *DocDB) DescribeDBInstancesPages(input *DescribeDBInstancesInput, fn func(*DescribeDBInstancesOutput, bool) bool) error

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

See DescribeDBInstances 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 DescribeDBInstances operation.
pageNum := 0
err := client.DescribeDBInstancesPages(params,
    func(page *docdb.DescribeDBInstancesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DocDB) DescribeDBInstancesPagesWithContext 

func (c *DocDB) DescribeDBInstancesPagesWithContext(ctx aws.Context, input *DescribeDBInstancesInput, fn func(*DescribeDBInstancesOutput, bool) bool, opts ...request.Option) error

DescribeDBInstancesPagesWithContext same as DescribeDBInstancesPages 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 (*DocDB) DescribeDBInstancesRequest 

func (c *DocDB) DescribeDBInstancesRequest(input *DescribeDBInstancesInput) (req *request.Request, output *DescribeDBInstancesOutput)

DescribeDBInstancesRequest generates a "aws/request.Request" representing the client's request for the DescribeDBInstances 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 DescribeDBInstances for more information on using the DescribeDBInstances 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 DescribeDBInstancesRequest method.
req, resp := client.DescribeDBInstancesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBInstances

func (*DocDB) DescribeDBInstancesWithContext 

func (c *DocDB) DescribeDBInstancesWithContext(ctx aws.Context, input *DescribeDBInstancesInput, opts ...request.Option) (*DescribeDBInstancesOutput, error)

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

See DescribeDBInstances 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 (*DocDB) DescribeDBSubnetGroups 

func (c *DocDB) DescribeDBSubnetGroups(input *DescribeDBSubnetGroupsInput) (*DescribeDBSubnetGroupsOutput, error)

DescribeDBSubnetGroups API operation for Amazon DocumentDB with MongoDB compatibility.

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

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 with MongoDB compatibility's API operation DescribeDBSubnetGroups for usage and error information.

Returned Error Codes:

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing subnet group.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBSubnetGroups

func (*DocDB) DescribeDBSubnetGroupsPages 

func (c *DocDB) DescribeDBSubnetGroupsPages(input *DescribeDBSubnetGroupsInput, fn func(*DescribeDBSubnetGroupsOutput, bool) bool) error

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

See DescribeDBSubnetGroups 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 DescribeDBSubnetGroups operation.
pageNum := 0
err := client.DescribeDBSubnetGroupsPages(params,
    func(page *docdb.DescribeDBSubnetGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DocDB) DescribeDBSubnetGroupsPagesWithContext 

func (c *DocDB) DescribeDBSubnetGroupsPagesWithContext(ctx aws.Context, input *DescribeDBSubnetGroupsInput, fn func(*DescribeDBSubnetGroupsOutput, bool) bool, opts ...request.Option) error

DescribeDBSubnetGroupsPagesWithContext same as DescribeDBSubnetGroupsPages 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 (*DocDB) DescribeDBSubnetGroupsRequest 

func (c *DocDB) DescribeDBSubnetGroupsRequest(input *DescribeDBSubnetGroupsInput) (req *request.Request, output *DescribeDBSubnetGroupsOutput)

DescribeDBSubnetGroupsRequest generates a "aws/request.Request" representing the client's request for the DescribeDBSubnetGroups 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 DescribeDBSubnetGroups for more information on using the DescribeDBSubnetGroups 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 DescribeDBSubnetGroupsRequest method.
req, resp := client.DescribeDBSubnetGroupsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBSubnetGroups

func (*DocDB) DescribeDBSubnetGroupsWithContext 

func (c *DocDB) DescribeDBSubnetGroupsWithContext(ctx aws.Context, input *DescribeDBSubnetGroupsInput, opts ...request.Option) (*DescribeDBSubnetGroupsOutput, error)

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

See DescribeDBSubnetGroups 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 (*DocDB) DescribeEngineDefaultClusterParameters 

func (c *DocDB) DescribeEngineDefaultClusterParameters(input *DescribeEngineDefaultClusterParametersInput) (*DescribeEngineDefaultClusterParametersOutput, error)

DescribeEngineDefaultClusterParameters API operation for Amazon DocumentDB with MongoDB compatibility.

Returns the default engine and system parameter information for the cluster database engine.

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 with MongoDB compatibility's API operation DescribeEngineDefaultClusterParameters for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEngineDefaultClusterParameters

func (*DocDB) DescribeEngineDefaultClusterParametersRequest 

func (c *DocDB) DescribeEngineDefaultClusterParametersRequest(input *DescribeEngineDefaultClusterParametersInput) (req *request.Request, output *DescribeEngineDefaultClusterParametersOutput)

DescribeEngineDefaultClusterParametersRequest generates a "aws/request.Request" representing the client's request for the DescribeEngineDefaultClusterParameters 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 DescribeEngineDefaultClusterParameters for more information on using the DescribeEngineDefaultClusterParameters 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 DescribeEngineDefaultClusterParametersRequest method.
req, resp := client.DescribeEngineDefaultClusterParametersRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEngineDefaultClusterParameters

func (*DocDB) DescribeEngineDefaultClusterParametersWithContext 

func (c *DocDB) DescribeEngineDefaultClusterParametersWithContext(ctx aws.Context, input *DescribeEngineDefaultClusterParametersInput, opts ...request.Option) (*DescribeEngineDefaultClusterParametersOutput, error)

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

See DescribeEngineDefaultClusterParameters 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 (*DocDB) DescribeEventCategories 

func (c *DocDB) DescribeEventCategories(input *DescribeEventCategoriesInput) (*DescribeEventCategoriesOutput, error)

DescribeEventCategories API operation for Amazon DocumentDB with MongoDB compatibility.

Displays a list of categories for all event source types, or, if specified, for a specified source type.

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 with MongoDB compatibility's API operation DescribeEventCategories for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEventCategories

func (*DocDB) DescribeEventCategoriesRequest 

func (c *DocDB) DescribeEventCategoriesRequest(input *DescribeEventCategoriesInput) (req *request.Request, output *DescribeEventCategoriesOutput)

DescribeEventCategoriesRequest generates a "aws/request.Request" representing the client's request for the DescribeEventCategories 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 DescribeEventCategories for more information on using the DescribeEventCategories 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 DescribeEventCategoriesRequest method.
req, resp := client.DescribeEventCategoriesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEventCategories

func (*DocDB) DescribeEventCategoriesWithContext 

func (c *DocDB) DescribeEventCategoriesWithContext(ctx aws.Context, input *DescribeEventCategoriesInput, opts ...request.Option) (*DescribeEventCategoriesOutput, error)

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

See DescribeEventCategories 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 (*DocDB) DescribeEventSubscriptions added in v1.38.8 

func (c *DocDB) DescribeEventSubscriptions(input *DescribeEventSubscriptionsInput) (*DescribeEventSubscriptionsOutput, error)

DescribeEventSubscriptions API operation for Amazon DocumentDB with MongoDB compatibility.

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

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 with MongoDB compatibility's API operation DescribeEventSubscriptions for usage and error information.

Returned Error Codes:

  • ErrCodeSubscriptionNotFoundFault "SubscriptionNotFound" The subscription name does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEventSubscriptions

func (*DocDB) DescribeEventSubscriptionsPages added in v1.38.8 

func (c *DocDB) DescribeEventSubscriptionsPages(input *DescribeEventSubscriptionsInput, fn func(*DescribeEventSubscriptionsOutput, bool) bool) error

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

See DescribeEventSubscriptions 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 DescribeEventSubscriptions operation.
pageNum := 0
err := client.DescribeEventSubscriptionsPages(params,
    func(page *docdb.DescribeEventSubscriptionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DocDB) DescribeEventSubscriptionsPagesWithContext added in v1.38.8 

func (c *DocDB) DescribeEventSubscriptionsPagesWithContext(ctx aws.Context, input *DescribeEventSubscriptionsInput, fn func(*DescribeEventSubscriptionsOutput, bool) bool, opts ...request.Option) error

DescribeEventSubscriptionsPagesWithContext same as DescribeEventSubscriptionsPages 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 (*DocDB) DescribeEventSubscriptionsRequest added in v1.38.8 

func (c *DocDB) DescribeEventSubscriptionsRequest(input *DescribeEventSubscriptionsInput) (req *request.Request, output *DescribeEventSubscriptionsOutput)

DescribeEventSubscriptionsRequest generates a "aws/request.Request" representing the client's request for the DescribeEventSubscriptions 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 DescribeEventSubscriptions for more information on using the DescribeEventSubscriptions 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 DescribeEventSubscriptionsRequest method.
req, resp := client.DescribeEventSubscriptionsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEventSubscriptions

func (*DocDB) DescribeEventSubscriptionsWithContext added in v1.38.8 

func (c *DocDB) DescribeEventSubscriptionsWithContext(ctx aws.Context, input *DescribeEventSubscriptionsInput, opts ...request.Option) (*DescribeEventSubscriptionsOutput, error)

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

See DescribeEventSubscriptions 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 (*DocDB) DescribeEvents 

func (c *DocDB) DescribeEvents(input *DescribeEventsInput) (*DescribeEventsOutput, error)

DescribeEvents API operation for Amazon DocumentDB with MongoDB compatibility.

Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.

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 with MongoDB compatibility's API operation DescribeEvents for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEvents

func (*DocDB) DescribeEventsPages 

func (c *DocDB) DescribeEventsPages(input *DescribeEventsInput, fn func(*DescribeEventsOutput, bool) bool) error

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

See DescribeEvents 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 DescribeEvents operation.
pageNum := 0
err := client.DescribeEventsPages(params,
    func(page *docdb.DescribeEventsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DocDB) DescribeEventsPagesWithContext 

func (c *DocDB) DescribeEventsPagesWithContext(ctx aws.Context, input *DescribeEventsInput, fn func(*DescribeEventsOutput, bool) bool, opts ...request.Option) error

DescribeEventsPagesWithContext same as DescribeEventsPages 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 (*DocDB) DescribeEventsRequest 

func (c *DocDB) DescribeEventsRequest(input *DescribeEventsInput) (req *request.Request, output *DescribeEventsOutput)

DescribeEventsRequest generates a "aws/request.Request" representing the client's request for the DescribeEvents 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 DescribeEvents for more information on using the DescribeEvents 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 DescribeEventsRequest method.
req, resp := client.DescribeEventsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEvents

func (*DocDB) DescribeEventsWithContext 

func (c *DocDB) DescribeEventsWithContext(ctx aws.Context, input *DescribeEventsInput, opts ...request.Option) (*DescribeEventsOutput, error)

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

See DescribeEvents 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 (*DocDB) DescribeGlobalClusters added in v1.38.53 

func (c *DocDB) DescribeGlobalClusters(input *DescribeGlobalClustersInput) (*DescribeGlobalClustersOutput, error)

DescribeGlobalClusters API operation for Amazon DocumentDB with MongoDB compatibility.

Returns information about Amazon DocumentDB global clusters. This API supports pagination.

This action only applies to Amazon DocumentDB 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 with MongoDB compatibility's API operation DescribeGlobalClusters for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalClusterNotFoundFault "GlobalClusterNotFoundFault" The GlobalClusterIdentifier doesn't refer to an existing global cluster.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeGlobalClusters

func (*DocDB) DescribeGlobalClustersPages added in v1.38.53 

func (c *DocDB) DescribeGlobalClustersPages(input *DescribeGlobalClustersInput, fn func(*DescribeGlobalClustersOutput, bool) bool) error

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

See DescribeGlobalClusters 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 DescribeGlobalClusters operation.
pageNum := 0
err := client.DescribeGlobalClustersPages(params,
    func(page *docdb.DescribeGlobalClustersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DocDB) DescribeGlobalClustersPagesWithContext added in v1.38.53 

func (c *DocDB) DescribeGlobalClustersPagesWithContext(ctx aws.Context, input *DescribeGlobalClustersInput, fn func(*DescribeGlobalClustersOutput, bool) bool, opts ...request.Option) error

DescribeGlobalClustersPagesWithContext same as DescribeGlobalClustersPages 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 (*DocDB) DescribeGlobalClustersRequest added in v1.38.53 

func (c *DocDB) DescribeGlobalClustersRequest(input *DescribeGlobalClustersInput) (req *request.Request, output *DescribeGlobalClustersOutput)

DescribeGlobalClustersRequest generates a "aws/request.Request" representing the client's request for the DescribeGlobalClusters 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 DescribeGlobalClusters for more information on using the DescribeGlobalClusters 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 DescribeGlobalClustersRequest method.
req, resp := client.DescribeGlobalClustersRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeGlobalClusters

func (*DocDB) DescribeGlobalClustersWithContext added in v1.38.53 

func (c *DocDB) DescribeGlobalClustersWithContext(ctx aws.Context, input *DescribeGlobalClustersInput, opts ...request.Option) (*DescribeGlobalClustersOutput, error)

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

See DescribeGlobalClusters 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 (*DocDB) DescribeOrderableDBInstanceOptions 

func (c *DocDB) DescribeOrderableDBInstanceOptions(input *DescribeOrderableDBInstanceOptionsInput) (*DescribeOrderableDBInstanceOptionsOutput, error)

DescribeOrderableDBInstanceOptions API operation for Amazon DocumentDB with MongoDB compatibility.

Returns a list of orderable instance options for the specified engine.

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 with MongoDB compatibility's API operation DescribeOrderableDBInstanceOptions for usage and error information. See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeOrderableDBInstanceOptions

func (*DocDB) DescribeOrderableDBInstanceOptionsPages 

func (c *DocDB) DescribeOrderableDBInstanceOptionsPages(input *DescribeOrderableDBInstanceOptionsInput, fn func(*DescribeOrderableDBInstanceOptionsOutput, bool) bool) error

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

See DescribeOrderableDBInstanceOptions 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 DescribeOrderableDBInstanceOptions operation.
pageNum := 0
err := client.DescribeOrderableDBInstanceOptionsPages(params,
    func(page *docdb.DescribeOrderableDBInstanceOptionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DocDB) DescribeOrderableDBInstanceOptionsPagesWithContext 

func (c *DocDB) DescribeOrderableDBInstanceOptionsPagesWithContext(ctx aws.Context, input *DescribeOrderableDBInstanceOptionsInput, fn func(*DescribeOrderableDBInstanceOptionsOutput, bool) bool, opts ...request.Option) error

DescribeOrderableDBInstanceOptionsPagesWithContext same as DescribeOrderableDBInstanceOptionsPages 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 (*DocDB) DescribeOrderableDBInstanceOptionsRequest 

func (c *DocDB) DescribeOrderableDBInstanceOptionsRequest(input *DescribeOrderableDBInstanceOptionsInput) (req *request.Request, output *DescribeOrderableDBInstanceOptionsOutput)

DescribeOrderableDBInstanceOptionsRequest generates a "aws/request.Request" representing the client's request for the DescribeOrderableDBInstanceOptions 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 DescribeOrderableDBInstanceOptions for more information on using the DescribeOrderableDBInstanceOptions 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 DescribeOrderableDBInstanceOptionsRequest method.
req, resp := client.DescribeOrderableDBInstanceOptionsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeOrderableDBInstanceOptions

func (*DocDB) DescribeOrderableDBInstanceOptionsWithContext 

func (c *DocDB) DescribeOrderableDBInstanceOptionsWithContext(ctx aws.Context, input *DescribeOrderableDBInstanceOptionsInput, opts ...request.Option) (*DescribeOrderableDBInstanceOptionsOutput, error)

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

See DescribeOrderableDBInstanceOptions 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 (*DocDB) DescribePendingMaintenanceActions 

func (c *DocDB) DescribePendingMaintenanceActions(input *DescribePendingMaintenanceActionsInput) (*DescribePendingMaintenanceActionsOutput, error)

DescribePendingMaintenanceActions API operation for Amazon DocumentDB with MongoDB compatibility.

Returns a list of resources (for example, instances) that have at least one pending maintenance action.

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 with MongoDB compatibility's API operation DescribePendingMaintenanceActions for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundFault "ResourceNotFoundFault" The specified resource ID was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribePendingMaintenanceActions

func (*DocDB) DescribePendingMaintenanceActionsPages added in v1.34.23 

func (c *DocDB) DescribePendingMaintenanceActionsPages(input *DescribePendingMaintenanceActionsInput, fn func(*DescribePendingMaintenanceActionsOutput, bool) bool) error

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

See DescribePendingMaintenanceActions 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 DescribePendingMaintenanceActions operation.
pageNum := 0
err := client.DescribePendingMaintenanceActionsPages(params,
    func(page *docdb.DescribePendingMaintenanceActionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*DocDB) DescribePendingMaintenanceActionsPagesWithContext added in v1.34.23 

func (c *DocDB) DescribePendingMaintenanceActionsPagesWithContext(ctx aws.Context, input *DescribePendingMaintenanceActionsInput, fn func(*DescribePendingMaintenanceActionsOutput, bool) bool, opts ...request.Option) error

DescribePendingMaintenanceActionsPagesWithContext same as DescribePendingMaintenanceActionsPages 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 (*DocDB) DescribePendingMaintenanceActionsRequest 

func (c *DocDB) DescribePendingMaintenanceActionsRequest(input *DescribePendingMaintenanceActionsInput) (req *request.Request, output *DescribePendingMaintenanceActionsOutput)

DescribePendingMaintenanceActionsRequest generates a "aws/request.Request" representing the client's request for the DescribePendingMaintenanceActions 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 DescribePendingMaintenanceActions for more information on using the DescribePendingMaintenanceActions 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 DescribePendingMaintenanceActionsRequest method.
req, resp := client.DescribePendingMaintenanceActionsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribePendingMaintenanceActions

func (*DocDB) DescribePendingMaintenanceActionsWithContext 

func (c *DocDB) DescribePendingMaintenanceActionsWithContext(ctx aws.Context, input *DescribePendingMaintenanceActionsInput, opts ...request.Option) (*DescribePendingMaintenanceActionsOutput, error)

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

See DescribePendingMaintenanceActions 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 (*DocDB) FailoverDBCluster 

func (c *DocDB) FailoverDBCluster(input *FailoverDBClusterInput) (*FailoverDBClusterOutput, error)

FailoverDBCluster API operation for Amazon DocumentDB with MongoDB compatibility.

Forces a failover for a cluster.

A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).

If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.

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 with MongoDB compatibility's API operation FailoverDBCluster for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing cluster.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The cluster isn't in a valid state.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The specified instance isn't in the available state.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/FailoverDBCluster

func (*DocDB) FailoverDBClusterRequest 

func (c *DocDB) FailoverDBClusterRequest(input *FailoverDBClusterInput) (req *request.Request, output *FailoverDBClusterOutput)

FailoverDBClusterRequest generates a "aws/request.Request" representing the client's request for the FailoverDBCluster 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 FailoverDBCluster for more information on using the FailoverDBCluster 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 FailoverDBClusterRequest method.
req, resp := client.FailoverDBClusterRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/FailoverDBCluster

func (*DocDB) FailoverDBClusterWithContext 

func (c *DocDB) FailoverDBClusterWithContext(ctx aws.Context, input *FailoverDBClusterInput, opts ...request.Option) (*FailoverDBClusterOutput, error)

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

See FailoverDBCluster 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 (*DocDB) ListTagsForResource 

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

ListTagsForResource API operation for Amazon DocumentDB with MongoDB compatibility.

Lists all tags on an Amazon DocumentDB 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 with MongoDB compatibility's API operation ListTagsForResource for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing instance.

  • ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound" DBSnapshotIdentifier doesn't refer to an existing snapshot.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing cluster.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ListTagsForResource

func (*DocDB) ListTagsForResourceRequest 

func (c *DocDB) 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-2014-10-31/ListTagsForResource

func (*DocDB) ListTagsForResourceWithContext 

func (c *DocDB) 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 (*DocDB) ModifyDBCluster 

func (c *DocDB) ModifyDBCluster(input *ModifyDBClusterInput) (*ModifyDBClusterOutput, error)

ModifyDBCluster API operation for Amazon DocumentDB with MongoDB compatibility.

Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

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 with MongoDB compatibility's API operation ModifyDBCluster for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing cluster.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The cluster isn't in a valid state.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would cause you to exceed the allowed amount of storage available across all instances.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing subnet group.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

  • ErrCodeInvalidDBSubnetGroupStateFault "InvalidDBSubnetGroupStateFault" The subnet group can't be deleted because it's in use.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

  • ErrCodeDBClusterParameterGroupNotFoundFault "DBClusterParameterGroupNotFound" DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.

  • ErrCodeInvalidDBSecurityGroupStateFault "InvalidDBSecurityGroupState" The state of the security group doesn't allow deletion.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The specified instance isn't in the available state.

  • ErrCodeDBClusterAlreadyExistsFault "DBClusterAlreadyExistsFault" You already have a cluster with the given identifier.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBCluster

func (*DocDB) ModifyDBClusterParameterGroup 

func (c *DocDB) ModifyDBClusterParameterGroup(input *ModifyDBClusterParameterGroupInput) (*ModifyDBClusterParameterGroupOutput, error)

ModifyDBClusterParameterGroup API operation for Amazon DocumentDB with MongoDB compatibility.

Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.

After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter.

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 with MongoDB compatibility's API operation ModifyDBClusterParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing parameter group.

  • ErrCodeInvalidDBParameterGroupStateFault "InvalidDBParameterGroupState" The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterParameterGroup

func (*DocDB) ModifyDBClusterParameterGroupRequest 

func (c *DocDB) ModifyDBClusterParameterGroupRequest(input *ModifyDBClusterParameterGroupInput) (req *request.Request, output *ModifyDBClusterParameterGroupOutput)

ModifyDBClusterParameterGroupRequest generates a "aws/request.Request" representing the client's request for the ModifyDBClusterParameterGroup 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 ModifyDBClusterParameterGroup for more information on using the ModifyDBClusterParameterGroup 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 ModifyDBClusterParameterGroupRequest method.
req, resp := client.ModifyDBClusterParameterGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterParameterGroup

func (*DocDB) ModifyDBClusterParameterGroupWithContext 

func (c *DocDB) ModifyDBClusterParameterGroupWithContext(ctx aws.Context, input *ModifyDBClusterParameterGroupInput, opts ...request.Option) (*ModifyDBClusterParameterGroupOutput, error)

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

See ModifyDBClusterParameterGroup 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 (*DocDB) ModifyDBClusterRequest 

func (c *DocDB) ModifyDBClusterRequest(input *ModifyDBClusterInput) (req *request.Request, output *ModifyDBClusterOutput)

ModifyDBClusterRequest generates a "aws/request.Request" representing the client's request for the ModifyDBCluster 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 ModifyDBCluster for more information on using the ModifyDBCluster 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 ModifyDBClusterRequest method.
req, resp := client.ModifyDBClusterRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBCluster

func (*DocDB) ModifyDBClusterSnapshotAttribute 

func (c *DocDB) ModifyDBClusterSnapshotAttribute(input *ModifyDBClusterSnapshotAttributeInput) (*ModifyDBClusterSnapshotAttributeOutput, error)

ModifyDBClusterSnapshotAttribute API operation for Amazon DocumentDB with MongoDB compatibility.

Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.

To share a manual cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Do not add the all value for any manual cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

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 with MongoDB compatibility's API operation ModifyDBClusterSnapshotAttribute for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault" DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

  • ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault" The provided value isn't a valid cluster snapshot state.

  • ErrCodeSharedSnapshotQuotaExceededFault "SharedSnapshotQuotaExceeded" You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute

func (*DocDB) ModifyDBClusterSnapshotAttributeRequest 

func (c *DocDB) ModifyDBClusterSnapshotAttributeRequest(input *ModifyDBClusterSnapshotAttributeInput) (req *request.Request, output *ModifyDBClusterSnapshotAttributeOutput)

ModifyDBClusterSnapshotAttributeRequest generates a "aws/request.Request" representing the client's request for the ModifyDBClusterSnapshotAttribute 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 ModifyDBClusterSnapshotAttribute for more information on using the ModifyDBClusterSnapshotAttribute 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 ModifyDBClusterSnapshotAttributeRequest method.
req, resp := client.ModifyDBClusterSnapshotAttributeRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute

func (*DocDB) ModifyDBClusterSnapshotAttributeWithContext 

func (c *DocDB) ModifyDBClusterSnapshotAttributeWithContext(ctx aws.Context, input *ModifyDBClusterSnapshotAttributeInput, opts ...request.Option) (*ModifyDBClusterSnapshotAttributeOutput, error)

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

See ModifyDBClusterSnapshotAttribute 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 (*DocDB) ModifyDBClusterWithContext 

func (c *DocDB) ModifyDBClusterWithContext(ctx aws.Context, input *ModifyDBClusterInput, opts ...request.Option) (*ModifyDBClusterOutput, error)

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

See ModifyDBCluster 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 (*DocDB) ModifyDBInstance 

func (c *DocDB) ModifyDBInstance(input *ModifyDBInstanceInput) (*ModifyDBInstanceOutput, error)

ModifyDBInstance API operation for Amazon DocumentDB with MongoDB compatibility.

Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

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 with MongoDB compatibility's API operation ModifyDBInstance for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The specified instance isn't in the available state.

  • ErrCodeInvalidDBSecurityGroupStateFault "InvalidDBSecurityGroupState" The state of the security group doesn't allow deletion.

  • ErrCodeDBInstanceAlreadyExistsFault "DBInstanceAlreadyExists" You already have a instance with the given identifier.

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing instance.

  • ErrCodeDBSecurityGroupNotFoundFault "DBSecurityGroupNotFound" DBSecurityGroupName doesn't refer to an existing security group.

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing parameter group.

  • ErrCodeInsufficientDBInstanceCapacityFault "InsufficientDBInstanceCapacity" The specified instance class isn't available in the specified Availability Zone.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would cause you to exceed the allowed amount of storage available across all instances.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

  • ErrCodeDBUpgradeDependencyFailureFault "DBUpgradeDependencyFailure" The upgrade failed because a resource that the depends on can't be modified.

  • ErrCodeStorageTypeNotSupportedFault "StorageTypeNotSupported" Storage of the specified StorageType can't be associated with the DB instance.

  • ErrCodeAuthorizationNotFoundFault "AuthorizationNotFound" The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.

    Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.

  • ErrCodeCertificateNotFoundFault "CertificateNotFound" CertificateIdentifier doesn't refer to an existing certificate.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBInstance

func (*DocDB) ModifyDBInstanceRequest 

func (c *DocDB) ModifyDBInstanceRequest(input *ModifyDBInstanceInput) (req *request.Request, output *ModifyDBInstanceOutput)

ModifyDBInstanceRequest generates a "aws/request.Request" representing the client's request for the ModifyDBInstance 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 ModifyDBInstance for more information on using the ModifyDBInstance 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 ModifyDBInstanceRequest method.
req, resp := client.ModifyDBInstanceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBInstance

func (*DocDB) ModifyDBInstanceWithContext 

func (c *DocDB) ModifyDBInstanceWithContext(ctx aws.Context, input *ModifyDBInstanceInput, opts ...request.Option) (*ModifyDBInstanceOutput, error)

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

See ModifyDBInstance 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 (*DocDB) ModifyDBSubnetGroup 

func (c *DocDB) ModifyDBSubnetGroup(input *ModifyDBSubnetGroupInput) (*ModifyDBSubnetGroupOutput, error)

ModifyDBSubnetGroup API operation for Amazon DocumentDB with MongoDB compatibility.

Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.

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 with MongoDB compatibility's API operation ModifyDBSubnetGroup for usage and error information.

Returned Error Codes:

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing subnet group.

  • ErrCodeDBSubnetQuotaExceededFault "DBSubnetQuotaExceededFault" The request would cause you to exceed the allowed number of subnets in a subnet group.

  • ErrCodeSubnetAlreadyInUse "SubnetAlreadyInUse" The subnet is already in use in the Availability Zone.

  • ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs "DBSubnetGroupDoesNotCoverEnoughAZs" Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBSubnetGroup

func (*DocDB) ModifyDBSubnetGroupRequest 

func (c *DocDB) ModifyDBSubnetGroupRequest(input *ModifyDBSubnetGroupInput) (req *request.Request, output *ModifyDBSubnetGroupOutput)

ModifyDBSubnetGroupRequest generates a "aws/request.Request" representing the client's request for the ModifyDBSubnetGroup 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 ModifyDBSubnetGroup for more information on using the ModifyDBSubnetGroup 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 ModifyDBSubnetGroupRequest method.
req, resp := client.ModifyDBSubnetGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBSubnetGroup

func (*DocDB) ModifyDBSubnetGroupWithContext 

func (c *DocDB) ModifyDBSubnetGroupWithContext(ctx aws.Context, input *ModifyDBSubnetGroupInput, opts ...request.Option) (*ModifyDBSubnetGroupOutput, error)

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

See ModifyDBSubnetGroup 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 (*DocDB) ModifyEventSubscription added in v1.38.8 

func (c *DocDB) ModifyEventSubscription(input *ModifyEventSubscriptionInput) (*ModifyEventSubscriptionOutput, error)

ModifyEventSubscription API operation for Amazon DocumentDB with MongoDB compatibility.

Modifies an existing Amazon DocumentDB event notification subscription.

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 with MongoDB compatibility's API operation ModifyEventSubscription for usage and error information.

Returned Error Codes:

  • ErrCodeEventSubscriptionQuotaExceededFault "EventSubscriptionQuotaExceeded" You have reached the maximum number of event subscriptions.

  • ErrCodeSubscriptionNotFoundFault "SubscriptionNotFound" The subscription name does not exist.

  • ErrCodeSNSInvalidTopicFault "SNSInvalidTopic" Amazon SNS has responded that there is a problem with the specified topic.

  • ErrCodeSNSNoAuthorizationFault "SNSNoAuthorization" You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).

  • ErrCodeSNSTopicArnNotFoundFault "SNSTopicArnNotFound" The SNS topic Amazon Resource Name (ARN) does not exist.

  • ErrCodeSubscriptionCategoryNotFoundFault "SubscriptionCategoryNotFound" The provided category does not exist.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyEventSubscription

func (*DocDB) ModifyEventSubscriptionRequest added in v1.38.8 

func (c *DocDB) ModifyEventSubscriptionRequest(input *ModifyEventSubscriptionInput) (req *request.Request, output *ModifyEventSubscriptionOutput)

ModifyEventSubscriptionRequest generates a "aws/request.Request" representing the client's request for the ModifyEventSubscription 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 ModifyEventSubscription for more information on using the ModifyEventSubscription 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 ModifyEventSubscriptionRequest method.
req, resp := client.ModifyEventSubscriptionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyEventSubscription

func (*DocDB) ModifyEventSubscriptionWithContext added in v1.38.8 

func (c *DocDB) ModifyEventSubscriptionWithContext(ctx aws.Context, input *ModifyEventSubscriptionInput, opts ...request.Option) (*ModifyEventSubscriptionOutput, error)

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

See ModifyEventSubscription 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 (*DocDB) ModifyGlobalCluster added in v1.38.53 

func (c *DocDB) ModifyGlobalCluster(input *ModifyGlobalClusterInput) (*ModifyGlobalClusterOutput, error)

ModifyGlobalCluster API operation for Amazon DocumentDB with MongoDB compatibility.

Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.

This action only applies to Amazon DocumentDB 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 with MongoDB compatibility's API operation ModifyGlobalCluster for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalClusterNotFoundFault "GlobalClusterNotFoundFault" The GlobalClusterIdentifier doesn't refer to an existing global cluster.

  • ErrCodeInvalidGlobalClusterStateFault "InvalidGlobalClusterStateFault" The requested operation can't be performed while the cluster is in this state.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyGlobalCluster

func (*DocDB) ModifyGlobalClusterRequest added in v1.38.53 

func (c *DocDB) ModifyGlobalClusterRequest(input *ModifyGlobalClusterInput) (req *request.Request, output *ModifyGlobalClusterOutput)

ModifyGlobalClusterRequest generates a "aws/request.Request" representing the client's request for the ModifyGlobalCluster 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 ModifyGlobalCluster for more information on using the ModifyGlobalCluster 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 ModifyGlobalClusterRequest method.
req, resp := client.ModifyGlobalClusterRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyGlobalCluster

func (*DocDB) ModifyGlobalClusterWithContext added in v1.38.53 

func (c *DocDB) ModifyGlobalClusterWithContext(ctx aws.Context, input *ModifyGlobalClusterInput, opts ...request.Option) (*ModifyGlobalClusterOutput, error)

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

See ModifyGlobalCluster 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 (*DocDB) RebootDBInstance 

func (c *DocDB) RebootDBInstance(input *RebootDBInstanceInput) (*RebootDBInstanceOutput, error)

RebootDBInstance API operation for Amazon DocumentDB with MongoDB compatibility.

You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect.

Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting.

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 with MongoDB compatibility's API operation RebootDBInstance for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The specified instance isn't in the available state.

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing instance.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RebootDBInstance

func (*DocDB) RebootDBInstanceRequest 

func (c *DocDB) RebootDBInstanceRequest(input *RebootDBInstanceInput) (req *request.Request, output *RebootDBInstanceOutput)

RebootDBInstanceRequest generates a "aws/request.Request" representing the client's request for the RebootDBInstance 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 RebootDBInstance for more information on using the RebootDBInstance 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 RebootDBInstanceRequest method.
req, resp := client.RebootDBInstanceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RebootDBInstance

func (*DocDB) RebootDBInstanceWithContext 

func (c *DocDB) RebootDBInstanceWithContext(ctx aws.Context, input *RebootDBInstanceInput, opts ...request.Option) (*RebootDBInstanceOutput, error)

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

See RebootDBInstance 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 (*DocDB) RemoveFromGlobalCluster added in v1.38.53 

func (c *DocDB) RemoveFromGlobalCluster(input *RemoveFromGlobalClusterInput) (*RemoveFromGlobalClusterOutput, error)

RemoveFromGlobalCluster API operation for Amazon DocumentDB with MongoDB compatibility.

Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region.

This action only applies to Amazon DocumentDB 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 with MongoDB compatibility's API operation RemoveFromGlobalCluster for usage and error information.

Returned Error Codes:

  • ErrCodeGlobalClusterNotFoundFault "GlobalClusterNotFoundFault" The GlobalClusterIdentifier doesn't refer to an existing global cluster.

  • ErrCodeInvalidGlobalClusterStateFault "InvalidGlobalClusterStateFault" The requested operation can't be performed while the cluster is in this state.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing cluster.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveFromGlobalCluster

func (*DocDB) RemoveFromGlobalClusterRequest added in v1.38.53 

func (c *DocDB) RemoveFromGlobalClusterRequest(input *RemoveFromGlobalClusterInput) (req *request.Request, output *RemoveFromGlobalClusterOutput)

RemoveFromGlobalClusterRequest generates a "aws/request.Request" representing the client's request for the RemoveFromGlobalCluster 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 RemoveFromGlobalCluster for more information on using the RemoveFromGlobalCluster 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 RemoveFromGlobalClusterRequest method.
req, resp := client.RemoveFromGlobalClusterRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveFromGlobalCluster

func (*DocDB) RemoveFromGlobalClusterWithContext added in v1.38.53 

func (c *DocDB) RemoveFromGlobalClusterWithContext(ctx aws.Context, input *RemoveFromGlobalClusterInput, opts ...request.Option) (*RemoveFromGlobalClusterOutput, error)

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

See RemoveFromGlobalCluster 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 (*DocDB) RemoveSourceIdentifierFromSubscription added in v1.38.8 

func (c *DocDB) RemoveSourceIdentifierFromSubscription(input *RemoveSourceIdentifierFromSubscriptionInput) (*RemoveSourceIdentifierFromSubscriptionOutput, error)

RemoveSourceIdentifierFromSubscription API operation for Amazon DocumentDB with MongoDB compatibility.

Removes a source identifier from an existing Amazon DocumentDB event notification subscription.

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 with MongoDB compatibility's API operation RemoveSourceIdentifierFromSubscription for usage and error information.

Returned Error Codes:

  • ErrCodeSubscriptionNotFoundFault "SubscriptionNotFound" The subscription name does not exist.

  • ErrCodeSourceNotFoundFault "SourceNotFound" The requested source could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription

func (*DocDB) RemoveSourceIdentifierFromSubscriptionRequest added in v1.38.8 

func (c *DocDB) RemoveSourceIdentifierFromSubscriptionRequest(input *RemoveSourceIdentifierFromSubscriptionInput) (req *request.Request, output *RemoveSourceIdentifierFromSubscriptionOutput)

RemoveSourceIdentifierFromSubscriptionRequest generates a "aws/request.Request" representing the client's request for the RemoveSourceIdentifierFromSubscription 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 RemoveSourceIdentifierFromSubscription for more information on using the RemoveSourceIdentifierFromSubscription 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 RemoveSourceIdentifierFromSubscriptionRequest method.
req, resp := client.RemoveSourceIdentifierFromSubscriptionRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveSourceIdentifierFromSubscription

func (*DocDB) RemoveSourceIdentifierFromSubscriptionWithContext added in v1.38.8 

func (c *DocDB) RemoveSourceIdentifierFromSubscriptionWithContext(ctx aws.Context, input *RemoveSourceIdentifierFromSubscriptionInput, opts ...request.Option) (*RemoveSourceIdentifierFromSubscriptionOutput, error)

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

See RemoveSourceIdentifierFromSubscription 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 (*DocDB) RemoveTagsFromResource 

func (c *DocDB) RemoveTagsFromResource(input *RemoveTagsFromResourceInput) (*RemoveTagsFromResourceOutput, error)

RemoveTagsFromResource API operation for Amazon DocumentDB with MongoDB compatibility.

Removes metadata tags from an Amazon DocumentDB 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 with MongoDB compatibility's API operation RemoveTagsFromResource for usage and error information.

Returned Error Codes:

  • ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound" DBInstanceIdentifier doesn't refer to an existing instance.

  • ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound" DBSnapshotIdentifier doesn't refer to an existing snapshot.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing cluster.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveTagsFromResource

func (*DocDB) RemoveTagsFromResourceRequest 

func (c *DocDB) RemoveTagsFromResourceRequest(input *RemoveTagsFromResourceInput) (req *request.Request, output *RemoveTagsFromResourceOutput)

RemoveTagsFromResourceRequest generates a "aws/request.Request" representing the client's request for the RemoveTagsFromResource 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 RemoveTagsFromResource for more information on using the RemoveTagsFromResource 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 RemoveTagsFromResourceRequest method.
req, resp := client.RemoveTagsFromResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveTagsFromResource

func (*DocDB) RemoveTagsFromResourceWithContext 

func (c *DocDB) RemoveTagsFromResourceWithContext(ctx aws.Context, input *RemoveTagsFromResourceInput, opts ...request.Option) (*RemoveTagsFromResourceOutput, error)

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

See RemoveTagsFromResource 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 (*DocDB) ResetDBClusterParameterGroup 

func (c *DocDB) ResetDBClusterParameterGroup(input *ResetDBClusterParameterGroupInput) (*ResetDBClusterParameterGroupOutput, error)

ResetDBClusterParameterGroup API operation for Amazon DocumentDB with MongoDB compatibility.

Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot.

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 with MongoDB compatibility's API operation ResetDBClusterParameterGroup for usage and error information.

Returned Error Codes:

  • ErrCodeInvalidDBParameterGroupStateFault "InvalidDBParameterGroupState" The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.

  • ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound" DBParameterGroupName doesn't refer to an existing parameter group.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ResetDBClusterParameterGroup

func (*DocDB) ResetDBClusterParameterGroupRequest 

func (c *DocDB) ResetDBClusterParameterGroupRequest(input *ResetDBClusterParameterGroupInput) (req *request.Request, output *ResetDBClusterParameterGroupOutput)

ResetDBClusterParameterGroupRequest generates a "aws/request.Request" representing the client's request for the ResetDBClusterParameterGroup 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 ResetDBClusterParameterGroup for more information on using the ResetDBClusterParameterGroup 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 ResetDBClusterParameterGroupRequest method.
req, resp := client.ResetDBClusterParameterGroupRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ResetDBClusterParameterGroup

func (*DocDB) ResetDBClusterParameterGroupWithContext 

func (c *DocDB) ResetDBClusterParameterGroupWithContext(ctx aws.Context, input *ResetDBClusterParameterGroupInput, opts ...request.Option) (*ResetDBClusterParameterGroupOutput, error)

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

See ResetDBClusterParameterGroup 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 (*DocDB) RestoreDBClusterFromSnapshot 

func (c *DocDB) RestoreDBClusterFromSnapshot(input *RestoreDBClusterFromSnapshotInput) (*RestoreDBClusterFromSnapshotOutput, error)

RestoreDBClusterFromSnapshot API operation for Amazon DocumentDB with MongoDB compatibility.

Creates a new cluster from a snapshot or cluster snapshot.

If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.

If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.

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 with MongoDB compatibility's API operation RestoreDBClusterFromSnapshot for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterAlreadyExistsFault "DBClusterAlreadyExistsFault" You already have a cluster with the given identifier.

  • ErrCodeDBClusterQuotaExceededFault "DBClusterQuotaExceededFault" The cluster can't be created because you have reached the maximum allowed quota of clusters.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would cause you to exceed the allowed amount of storage available across all instances.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing subnet group.

  • ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound" DBSnapshotIdentifier doesn't refer to an existing snapshot.

  • ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault" DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

  • ErrCodeInsufficientDBClusterCapacityFault "InsufficientDBClusterCapacityFault" The cluster doesn't have enough capacity for the current operation.

  • ErrCodeInsufficientStorageClusterCapacityFault "InsufficientStorageClusterCapacity" There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

  • ErrCodeInvalidDBSnapshotStateFault "InvalidDBSnapshotState" The state of the snapshot doesn't allow deletion.

  • ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault" The provided value isn't a valid cluster snapshot state.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would cause you to exceed the allowed amount of storage available across all instances.

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

  • ErrCodeInvalidRestoreFault "InvalidRestoreFault" You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing subnet group.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred when accessing an KMS key.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterFromSnapshot

func (*DocDB) RestoreDBClusterFromSnapshotRequest 

func (c *DocDB) RestoreDBClusterFromSnapshotRequest(input *RestoreDBClusterFromSnapshotInput) (req *request.Request, output *RestoreDBClusterFromSnapshotOutput)

RestoreDBClusterFromSnapshotRequest generates a "aws/request.Request" representing the client's request for the RestoreDBClusterFromSnapshot 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 RestoreDBClusterFromSnapshot for more information on using the RestoreDBClusterFromSnapshot 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 RestoreDBClusterFromSnapshotRequest method.
req, resp := client.RestoreDBClusterFromSnapshotRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterFromSnapshot

func (*DocDB) RestoreDBClusterFromSnapshotWithContext 

func (c *DocDB) RestoreDBClusterFromSnapshotWithContext(ctx aws.Context, input *RestoreDBClusterFromSnapshotInput, opts ...request.Option) (*RestoreDBClusterFromSnapshotOutput, error)

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

See RestoreDBClusterFromSnapshot 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 (*DocDB) RestoreDBClusterToPointInTime 

func (c *DocDB) RestoreDBClusterToPointInTime(input *RestoreDBClusterToPointInTimeInput) (*RestoreDBClusterToPointInTimeOutput, error)

RestoreDBClusterToPointInTime API operation for Amazon DocumentDB with MongoDB compatibility.

Restores a cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is created from the source cluster with the same configuration as the original cluster, except that the new cluster is created with the default security group.

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 with MongoDB compatibility's API operation RestoreDBClusterToPointInTime for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterAlreadyExistsFault "DBClusterAlreadyExistsFault" You already have a cluster with the given identifier.

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing cluster.

  • ErrCodeDBClusterQuotaExceededFault "DBClusterQuotaExceededFault" The cluster can't be created because you have reached the maximum allowed quota of clusters.

  • ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault" DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

  • ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault" DBSubnetGroupName doesn't refer to an existing subnet group.

  • ErrCodeInsufficientDBClusterCapacityFault "InsufficientDBClusterCapacityFault" The cluster doesn't have enough capacity for the current operation.

  • ErrCodeInsufficientStorageClusterCapacityFault "InsufficientStorageClusterCapacity" There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

  • ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault" The provided value isn't a valid cluster snapshot state.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The cluster isn't in a valid state.

  • ErrCodeInvalidDBSnapshotStateFault "InvalidDBSnapshotState" The state of the snapshot doesn't allow deletion.

  • ErrCodeInvalidRestoreFault "InvalidRestoreFault" You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.

  • ErrCodeInvalidSubnet "InvalidSubnet" The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

  • ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault" The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

  • ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault" An error occurred when accessing an KMS key.

  • ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded" The request would cause you to exceed the allowed amount of storage available across all instances.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterToPointInTime

func (*DocDB) RestoreDBClusterToPointInTimeRequest 

func (c *DocDB) RestoreDBClusterToPointInTimeRequest(input *RestoreDBClusterToPointInTimeInput) (req *request.Request, output *RestoreDBClusterToPointInTimeOutput)

RestoreDBClusterToPointInTimeRequest generates a "aws/request.Request" representing the client's request for the RestoreDBClusterToPointInTime 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 RestoreDBClusterToPointInTime for more information on using the RestoreDBClusterToPointInTime 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 RestoreDBClusterToPointInTimeRequest method.
req, resp := client.RestoreDBClusterToPointInTimeRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterToPointInTime

func (*DocDB) RestoreDBClusterToPointInTimeWithContext 

func (c *DocDB) RestoreDBClusterToPointInTimeWithContext(ctx aws.Context, input *RestoreDBClusterToPointInTimeInput, opts ...request.Option) (*RestoreDBClusterToPointInTimeOutput, error)

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

See RestoreDBClusterToPointInTime 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 (*DocDB) StartDBCluster added in v1.20.13 

func (c *DocDB) StartDBCluster(input *StartDBClusterInput) (*StartDBClusterOutput, error)

StartDBCluster API operation for Amazon DocumentDB with MongoDB compatibility.

Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster (https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html).

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 with MongoDB compatibility's API operation StartDBCluster for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing cluster.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The cluster isn't in a valid state.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The specified instance isn't in the available state.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/StartDBCluster

func (*DocDB) StartDBClusterRequest added in v1.20.13 

func (c *DocDB) StartDBClusterRequest(input *StartDBClusterInput) (req *request.Request, output *StartDBClusterOutput)

StartDBClusterRequest generates a "aws/request.Request" representing the client's request for the StartDBCluster 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 StartDBCluster for more information on using the StartDBCluster 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 StartDBClusterRequest method.
req, resp := client.StartDBClusterRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/StartDBCluster

func (*DocDB) StartDBClusterWithContext added in v1.20.13 

func (c *DocDB) StartDBClusterWithContext(ctx aws.Context, input *StartDBClusterInput, opts ...request.Option) (*StartDBClusterOutput, error)

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

See StartDBCluster 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 (*DocDB) StopDBCluster added in v1.20.13 

func (c *DocDB) StopDBCluster(input *StopDBClusterInput) (*StopDBClusterOutput, error)

StopDBCluster API operation for Amazon DocumentDB with MongoDB compatibility.

Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster (https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html).

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 with MongoDB compatibility's API operation StopDBCluster for usage and error information.

Returned Error Codes:

  • ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault" DBClusterIdentifier doesn't refer to an existing cluster.

  • ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault" The cluster isn't in a valid state.

  • ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState" The specified instance isn't in the available state.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/StopDBCluster

func (*DocDB) StopDBClusterRequest added in v1.20.13 

func (c *DocDB) StopDBClusterRequest(input *StopDBClusterInput) (req *request.Request, output *StopDBClusterOutput)

StopDBClusterRequest generates a "aws/request.Request" representing the client's request for the StopDBCluster 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 StopDBCluster for more information on using the StopDBCluster 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 StopDBClusterRequest method.
req, resp := client.StopDBClusterRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/StopDBCluster

func (*DocDB) StopDBClusterWithContext added in v1.20.13 

func (c *DocDB) StopDBClusterWithContext(ctx aws.Context, input *StopDBClusterInput, opts ...request.Option) (*StopDBClusterOutput, error)

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

See StopDBCluster 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 (*DocDB) WaitUntilDBInstanceAvailable 

func (c *DocDB) WaitUntilDBInstanceAvailable(input *DescribeDBInstancesInput) error

WaitUntilDBInstanceAvailable uses the Amazon DocDB API operation DescribeDBInstances to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*DocDB) WaitUntilDBInstanceAvailableWithContext 

func (c *DocDB) WaitUntilDBInstanceAvailableWithContext(ctx aws.Context, input *DescribeDBInstancesInput, opts ...request.WaiterOption) error

WaitUntilDBInstanceAvailableWithContext is an extended version of WaitUntilDBInstanceAvailable. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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 (*DocDB) WaitUntilDBInstanceDeleted 

func (c *DocDB) WaitUntilDBInstanceDeleted(input *DescribeDBInstancesInput) error

WaitUntilDBInstanceDeleted uses the Amazon DocDB API operation DescribeDBInstances to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

func (*DocDB) WaitUntilDBInstanceDeletedWithContext 

func (c *DocDB) WaitUntilDBInstanceDeletedWithContext(ctx aws.Context, input *DescribeDBInstancesInput, opts ...request.WaiterOption) error

WaitUntilDBInstanceDeletedWithContext is an extended version of WaitUntilDBInstanceDeleted. With the support for passing in a context and options to configure the Waiter and the underlying request options.

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 Endpoint 

type Endpoint struct {

	// Specifies the DNS address of the instance.
	Address *string `type:"string"`

	// Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
	HostedZoneId *string `type:"string"`

	// Specifies the port that the database engine is listening on.
	Port *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Network information for accessing a cluster or instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.

func (Endpoint) GoString 

func (s Endpoint) 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 (*Endpoint) SetAddress 

func (s *Endpoint) SetAddress(v string) *Endpoint

SetAddress sets the Address field's value.

func (*Endpoint) SetHostedZoneId 

func (s *Endpoint) SetHostedZoneId(v string) *Endpoint

SetHostedZoneId sets the HostedZoneId field's value.

func (*Endpoint) SetPort 

func (s *Endpoint) SetPort(v int64) *Endpoint

SetPort sets the Port field's value.

func (Endpoint) String 

func (s Endpoint) 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 EngineDefaults 

type EngineDefaults struct {

	// The name of the cluster parameter group family to return the engine parameter
	// information for.
	DBParameterGroupFamily *string `type:"string"`

	// An optional pagination token provided by a previous request. If this parameter
	// is specified, the response includes only records beyond the marker, up to
	// the value specified by MaxRecords.
	Marker *string `type:"string"`

	// The parameters of a particular cluster parameter group family.
	Parameters []*Parameter `locationNameList:"Parameter" type:"list"`
	// contains filtered or unexported fields
}

Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.

func (EngineDefaults) GoString 

func (s EngineDefaults) 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 (*EngineDefaults) SetDBParameterGroupFamily 

func (s *EngineDefaults) SetDBParameterGroupFamily(v string) *EngineDefaults

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*EngineDefaults) SetMarker 

func (s *EngineDefaults) SetMarker(v string) *EngineDefaults

SetMarker sets the Marker field's value.

func (*EngineDefaults) SetParameters 

func (s *EngineDefaults) SetParameters(v []*Parameter) *EngineDefaults

SetParameters sets the Parameters field's value.

func (EngineDefaults) String 

func (s EngineDefaults) 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 Event 

type Event struct {

	// Specifies the date and time of the event.
	Date *time.Time `type:"timestamp"`

	// Specifies the category for the event.
	EventCategories []*string `locationNameList:"EventCategory" type:"list"`

	// Provides the text of this event.
	Message *string `type:"string"`

	// The Amazon Resource Name (ARN) for the event.
	SourceArn *string `type:"string"`

	// Provides the identifier for the source of the event.
	SourceIdentifier *string `type:"string"`

	// Specifies the source type for this event.
	SourceType *string `type:"string" enum:"SourceType"`
	// contains filtered or unexported fields
}

Detailed information about an event.

func (Event) GoString 

func (s Event) 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 (*Event) SetDate 

func (s *Event) SetDate(v time.Time) *Event

SetDate sets the Date field's value.

func (*Event) SetEventCategories 

func (s *Event) SetEventCategories(v []*string) *Event

SetEventCategories sets the EventCategories field's value.

func (*Event) SetMessage 

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

SetMessage sets the Message field's value.

func (*Event) SetSourceArn 

func (s *Event) SetSourceArn(v string) *Event

SetSourceArn sets the SourceArn field's value.

func (*Event) SetSourceIdentifier 

func (s *Event) SetSourceIdentifier(v string) *Event

SetSourceIdentifier sets the SourceIdentifier field's value.

func (*Event) SetSourceType 

func (s *Event) SetSourceType(v string) *Event

SetSourceType sets the SourceType field's value.

func (Event) String 

func (s Event) 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 EventCategoriesMap 

type EventCategoriesMap struct {

	// The event categories for the specified source type.
	EventCategories []*string `locationNameList:"EventCategory" type:"list"`

	// The source type that the returned categories belong to.
	SourceType *string `type:"string"`
	// contains filtered or unexported fields
}

An event source type, accompanied by one or more event category names.

func (EventCategoriesMap) GoString 

func (s EventCategoriesMap) 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 (*EventCategoriesMap) SetEventCategories 

func (s *EventCategoriesMap) SetEventCategories(v []*string) *EventCategoriesMap

SetEventCategories sets the EventCategories field's value.

func (*EventCategoriesMap) SetSourceType 

func (s *EventCategoriesMap) SetSourceType(v string) *EventCategoriesMap

SetSourceType sets the SourceType field's value.

func (EventCategoriesMap) String 

func (s EventCategoriesMap) 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 EventSubscription added in v1.38.8 

type EventSubscription struct {

	// The Amazon DocumentDB event notification subscription ID.
	CustSubscriptionId *string `type:"string"`

	// The Amazon Web Services customer account that is associated with the Amazon
	// DocumentDB event notification subscription.
	CustomerAwsId *string `type:"string"`

	// A Boolean value indicating whether the subscription is enabled. A value of
	// true indicates that the subscription is enabled.
	Enabled *bool `type:"boolean"`

	// A list of event categories for the Amazon DocumentDB event notification subscription.
	EventCategoriesList []*string `locationNameList:"EventCategory" type:"list"`

	// The Amazon Resource Name (ARN) for the event subscription.
	EventSubscriptionArn *string `type:"string"`

	// The topic ARN of the Amazon DocumentDB event notification subscription.
	SnsTopicArn *string `type:"string"`

	// A list of source IDs for the Amazon DocumentDB event notification subscription.
	SourceIdsList []*string `locationNameList:"SourceId" type:"list"`

	// The source type for the Amazon DocumentDB event notification subscription.
	SourceType *string `type:"string"`

	// The status of the Amazon DocumentDB event notification subscription.
	//
	// Constraints:
	//
	// Can be one of the following: creating, modifying, deleting, active, no-permission,
	// topic-not-exist
	//
	// The no-permission status indicates that Amazon DocumentDB no longer has permission
	// to post to the SNS topic. The topic-not-exist status indicates that the topic
	// was deleted after the subscription was created.
	Status *string `type:"string"`

	// The time at which the Amazon DocumentDB event notification subscription was
	// created.
	SubscriptionCreationTime *string `type:"string"`
	// contains filtered or unexported fields
}

Detailed information about an event to which you have subscribed.

func (EventSubscription) GoString added in v1.38.8 

func (s EventSubscription) 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 (*EventSubscription) SetCustSubscriptionId added in v1.38.8 

func (s *EventSubscription) SetCustSubscriptionId(v string) *EventSubscription

SetCustSubscriptionId sets the CustSubscriptionId field's value.

func (*EventSubscription) SetCustomerAwsId added in v1.38.8 

func (s *EventSubscription) SetCustomerAwsId(v string) *EventSubscription

SetCustomerAwsId sets the CustomerAwsId field's value.

func (*EventSubscription) SetEnabled added in v1.38.8 

func (s *EventSubscription) SetEnabled(v bool) *EventSubscription

SetEnabled sets the Enabled field's value.

func (*EventSubscription) SetEventCategoriesList added in v1.38.8 

func (s *EventSubscription) SetEventCategoriesList(v []*string) *EventSubscription

SetEventCategoriesList sets the EventCategoriesList field's value.

func (*EventSubscription) SetEventSubscriptionArn added in v1.38.8 

func (s *EventSubscription) SetEventSubscriptionArn(v string) *EventSubscription

SetEventSubscriptionArn sets the EventSubscriptionArn field's value.

func (*EventSubscription) SetSnsTopicArn added in v1.38.8 

func (s *EventSubscription) SetSnsTopicArn(v string) *EventSubscription

SetSnsTopicArn sets the SnsTopicArn field's value.

func (*EventSubscription) SetSourceIdsList added in v1.38.8 

func (s *EventSubscription) SetSourceIdsList(v []*string) *EventSubscription

SetSourceIdsList sets the SourceIdsList field's value.

func (*EventSubscription) SetSourceType added in v1.38.8 

func (s *EventSubscription) SetSourceType(v string) *EventSubscription

SetSourceType sets the SourceType field's value.

func (*EventSubscription) SetStatus added in v1.38.8 

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

SetStatus sets the Status field's value.

func (*EventSubscription) SetSubscriptionCreationTime added in v1.38.8 

func (s *EventSubscription) SetSubscriptionCreationTime(v string) *EventSubscription

SetSubscriptionCreationTime sets the SubscriptionCreationTime field's value.

func (EventSubscription) String added in v1.38.8 

func (s EventSubscription) 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 FailoverDBClusterInput 

type FailoverDBClusterInput struct {

	// A cluster identifier to force a failover for. This parameter is not case
	// sensitive.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBCluster.
	DBClusterIdentifier *string `type:"string"`

	// The name of the instance to promote to the primary instance.
	//
	// You must specify the instance identifier for an Amazon DocumentDB replica
	// in the cluster. For example, mydbcluster-replica1.
	TargetDBInstanceIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the input to FailoverDBCluster.

func (FailoverDBClusterInput) GoString 

func (s FailoverDBClusterInput) 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 (*FailoverDBClusterInput) SetDBClusterIdentifier 

func (s *FailoverDBClusterInput) SetDBClusterIdentifier(v string) *FailoverDBClusterInput

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*FailoverDBClusterInput) SetTargetDBInstanceIdentifier 

func (s *FailoverDBClusterInput) SetTargetDBInstanceIdentifier(v string) *FailoverDBClusterInput

SetTargetDBInstanceIdentifier sets the TargetDBInstanceIdentifier field's value.

func (FailoverDBClusterInput) String 

func (s FailoverDBClusterInput) 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 FailoverDBClusterOutput 

type FailoverDBClusterOutput struct {

	// Detailed information about a cluster.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (FailoverDBClusterOutput) GoString 

func (s FailoverDBClusterOutput) 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 (*FailoverDBClusterOutput) SetDBCluster 

func (s *FailoverDBClusterOutput) SetDBCluster(v *DBCluster) *FailoverDBClusterOutput

SetDBCluster sets the DBCluster field's value.

func (FailoverDBClusterOutput) String 

func (s FailoverDBClusterOutput) 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 Filter 

type Filter struct {

	// The name of the filter. Filter names are case sensitive.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// One or more filter values. Filter values are case sensitive.
	//
	// Values is a required field
	Values []*string `locationNameList:"Value" type:"list" required:"true"`
	// contains filtered or unexported fields
}

A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

Wildcards are not supported in filters.

func (Filter) GoString 

func (s Filter) 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 (*Filter) SetName 

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

SetName sets the Name field's value.

func (*Filter) SetValues 

func (s *Filter) SetValues(v []*string) *Filter

SetValues sets the Values field's value.

func (Filter) String 

func (s Filter) 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 (*Filter) Validate 

func (s *Filter) Validate() error

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

type GlobalCluster added in v1.38.53 

type GlobalCluster struct {

	// The default database name within the new global cluster.
	DatabaseName *string `type:"string"`

	// The deletion protection setting for the new global cluster.
	DeletionProtection *bool `type:"boolean"`

	// The Amazon DocumentDB database engine used by the global cluster.
	Engine *string `type:"string"`

	// Indicates the database engine version.
	EngineVersion *string `type:"string"`

	// The Amazon Resource Name (ARN) for the global cluster.
	GlobalClusterArn *string `type:"string"`

	// Contains a user-supplied global cluster identifier. This identifier is the
	// unique key that identifies a global cluster.
	GlobalClusterIdentifier *string `min:"1" type:"string"`

	// The list of cluster IDs for secondary clusters within the global cluster.
	// Currently limited to one item.
	GlobalClusterMembers []*GlobalClusterMember `locationNameList:"GlobalClusterMember" type:"list"`

	// The Amazon Web Services Region-unique, immutable identifier for the global
	// database cluster. This identifier is found in CloudTrail log entries whenever
	// the KMS customer master key (CMK) for the cluster is accessed.
	GlobalClusterResourceId *string `type:"string"`

	// Specifies the current state of this global cluster.
	Status *string `type:"string"`

	// The storage encryption setting for the global cluster.
	StorageEncrypted *bool `type:"boolean"`
	// contains filtered or unexported fields
}

A data type representing an Amazon DocumentDB global cluster.

func (GlobalCluster) GoString added in v1.38.53 

func (s GlobalCluster) 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 (*GlobalCluster) SetDatabaseName added in v1.38.53 

func (s *GlobalCluster) SetDatabaseName(v string) *GlobalCluster

SetDatabaseName sets the DatabaseName field's value.

func (*GlobalCluster) SetDeletionProtection added in v1.38.53 

func (s *GlobalCluster) SetDeletionProtection(v bool) *GlobalCluster

SetDeletionProtection sets the DeletionProtection field's value.

func (*GlobalCluster) SetEngine added in v1.38.53 

func (s *GlobalCluster) SetEngine(v string) *GlobalCluster

SetEngine sets the Engine field's value.

func (*GlobalCluster) SetEngineVersion added in v1.38.53 

func (s *GlobalCluster) SetEngineVersion(v string) *GlobalCluster

SetEngineVersion sets the EngineVersion field's value.

func (*GlobalCluster) SetGlobalClusterArn added in v1.38.53 

func (s *GlobalCluster) SetGlobalClusterArn(v string) *GlobalCluster

SetGlobalClusterArn sets the GlobalClusterArn field's value.

func (*GlobalCluster) SetGlobalClusterIdentifier added in v1.38.53 

func (s *GlobalCluster) SetGlobalClusterIdentifier(v string) *GlobalCluster

SetGlobalClusterIdentifier sets the GlobalClusterIdentifier field's value.

func (*GlobalCluster) SetGlobalClusterMembers added in v1.38.53 

func (s *GlobalCluster) SetGlobalClusterMembers(v []*GlobalClusterMember) *GlobalCluster

SetGlobalClusterMembers sets the GlobalClusterMembers field's value.

func (*GlobalCluster) SetGlobalClusterResourceId added in v1.38.53 

func (s *GlobalCluster) SetGlobalClusterResourceId(v string) *GlobalCluster

SetGlobalClusterResourceId sets the GlobalClusterResourceId field's value.

func (*GlobalCluster) SetStatus added in v1.38.53 

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

SetStatus sets the Status field's value.

func (*GlobalCluster) SetStorageEncrypted added in v1.38.53 

func (s *GlobalCluster) SetStorageEncrypted(v bool) *GlobalCluster

SetStorageEncrypted sets the StorageEncrypted field's value.

func (GlobalCluster) String added in v1.38.53 

func (s GlobalCluster) 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 GlobalClusterMember added in v1.38.53 

type GlobalClusterMember struct {

	// The Amazon Resource Name (ARN) for each Amazon DocumentDB cluster.
	DBClusterArn *string `type:"string"`

	// Specifies whether the Amazon DocumentDB cluster is the primary cluster (that
	// is, has read-write capability) for the Amazon DocumentDB global cluster with
	// which it is associated.
	IsWriter *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) for each read-only secondary cluster associated
	// with the Aurora global cluster.
	Readers []*string `type:"list"`
	// contains filtered or unexported fields
}

A data structure with information about any primary and secondary clusters associated with an Amazon DocumentDB global clusters.

func (GlobalClusterMember) GoString added in v1.38.53 

func (s GlobalClusterMember) 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 (*GlobalClusterMember) SetDBClusterArn added in v1.38.53 

func (s *GlobalClusterMember) SetDBClusterArn(v string) *GlobalClusterMember

SetDBClusterArn sets the DBClusterArn field's value.

func (*GlobalClusterMember) SetIsWriter added in v1.38.53 

func (s *GlobalClusterMember) SetIsWriter(v bool) *GlobalClusterMember

SetIsWriter sets the IsWriter field's value.

func (*GlobalClusterMember) SetReaders added in v1.38.53 

func (s *GlobalClusterMember) SetReaders(v []*string) *GlobalClusterMember

SetReaders sets the Readers field's value.

func (GlobalClusterMember) String added in v1.38.53 

func (s GlobalClusterMember) 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 {

	// This parameter is not currently supported.
	Filters []*Filter `locationNameList:"Filter" type:"list"`

	// The Amazon DocumentDB resource with tags to be listed. This value is an Amazon
	// Resource Name (ARN).
	//
	// ResourceName is a required field
	ResourceName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to ListTagsForResource.

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

func (s *ListTagsForResourceInput) SetFilters(v []*Filter) *ListTagsForResourceInput

SetFilters sets the Filters field's value.

func (*ListTagsForResourceInput) SetResourceName 

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

SetResourceName sets the ResourceName 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 {

	// A list of one or more tags.
	TagList []*Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

Represents the output of ListTagsForResource.

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

func (s *ListTagsForResourceOutput) SetTagList(v []*Tag) *ListTagsForResourceOutput

SetTagList sets the TagList 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 ModifyDBClusterInput 

type ModifyDBClusterInput struct {

	// A value that indicates whether major version upgrades are allowed.
	//
	// Constraints: You must allow major version upgrades when specifying a value
	// for the EngineVersion parameter that is a different major version than the
	// DB cluster's current version.
	AllowMajorVersionUpgrade *bool `type:"boolean"`

	// A value that specifies whether the changes in this request and any pending
	// changes are asynchronously applied as soon as possible, regardless of the
	// PreferredMaintenanceWindow setting for the cluster. If this parameter is
	// set to false, changes to the cluster are applied during the next maintenance
	// window.
	//
	// The ApplyImmediately parameter affects only the NewDBClusterIdentifier and
	// MasterUserPassword values. If you set this parameter value to false, the
	// changes to the NewDBClusterIdentifier and MasterUserPassword values are applied
	// during the next maintenance window. All other changes are applied immediately,
	// regardless of the value of the ApplyImmediately parameter.
	//
	// Default: false
	ApplyImmediately *bool `type:"boolean"`

	// The number of days for which automated backups are retained. You must specify
	// a minimum value of 1.
	//
	// Default: 1
	//
	// Constraints:
	//
	//    * Must be a value from 1 to 35.
	BackupRetentionPeriod *int64 `type:"integer"`

	// The configuration setting for the log types to be enabled for export to Amazon
	// CloudWatch Logs for a specific instance or cluster. The EnableLogTypes and
	// DisableLogTypes arrays determine which logs are exported (or not exported)
	// to CloudWatch Logs.
	CloudwatchLogsExportConfiguration *CloudwatchLogsExportConfiguration `type:"structure"`

	// The cluster identifier for the cluster that is being modified. This parameter
	// is not case sensitive.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBCluster.
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The name of the cluster parameter group to use for the cluster.
	DBClusterParameterGroupName *string `type:"string"`

	// Specifies whether this cluster can be deleted. If DeletionProtection is enabled,
	// the cluster cannot be deleted unless it is modified and DeletionProtection
	// is disabled. DeletionProtection protects clusters from being accidentally
	// deleted.
	DeletionProtection *bool `type:"boolean"`

	// The version number of the database engine to which you want to upgrade. Changing
	// this parameter results in an outage. The change is applied during the next
	// maintenance window unless ApplyImmediately is enabled.
	//
	// To list all of the available engine versions for Amazon DocumentDB use the
	// following command:
	//
	// aws docdb describe-db-engine-versions --engine docdb --query "DBEngineVersions[].EngineVersion"
	EngineVersion *string `type:"string"`

	// The password for the master database user. 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.
	MasterUserPassword *string `type:"string"`

	// The new cluster identifier for the cluster when renaming a cluster. This
	// value 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-cluster2
	NewDBClusterIdentifier *string `type:"string"`

	// The port number on which the cluster accepts connections.
	//
	// Constraints: Must be a value from 1150 to 65535.
	//
	// Default: The same port as the original cluster.
	Port *int64 `type:"integer"`

	// The daily time range during which automated backups are created if automated
	// backups are enabled, using the BackupRetentionPeriod parameter.
	//
	// The default is a 30-minute window selected at random from an 8-hour block
	// of time for each Amazon Web Services Region.
	//
	// Constraints:
	//
	//    * Must be in the format hh24:mi-hh24:mi.
	//
	//    * Must be in Universal Coordinated Time (UTC).
	//
	//    * Must not conflict with the preferred maintenance window.
	//
	//    * Must be at least 30 minutes.
	PreferredBackupWindow *string `type:"string"`

	// The weekly time range during which system maintenance can occur, in Universal
	// Coordinated Time (UTC).
	//
	// Format: ddd:hh24:mi-ddd:hh24:mi
	//
	// The default is 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 `type:"string"`

	// The storage type to associate with the DB cluster.
	//
	// For information on storage types for Amazon DocumentDB clusters, see Cluster
	// storage configurations in the Amazon DocumentDB Developer Guide.
	//
	// Valid values for storage type - standard | iopt1
	//
	// Default value is standard
	StorageType *string `type:"string"`

	// A list of virtual private cloud (VPC) security groups that the cluster will
	// belong to.
	VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"`
	// contains filtered or unexported fields
}

Represents the input to ModifyDBCluster.

func (ModifyDBClusterInput) GoString 

func (s ModifyDBClusterInput) 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 (*ModifyDBClusterInput) SetAllowMajorVersionUpgrade added in v1.44.301 

func (s *ModifyDBClusterInput) SetAllowMajorVersionUpgrade(v bool) *ModifyDBClusterInput

SetAllowMajorVersionUpgrade sets the AllowMajorVersionUpgrade field's value.

func (*ModifyDBClusterInput) SetApplyImmediately 

func (s *ModifyDBClusterInput) SetApplyImmediately(v bool) *ModifyDBClusterInput

SetApplyImmediately sets the ApplyImmediately field's value.

func (*ModifyDBClusterInput) SetBackupRetentionPeriod 

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*ModifyDBClusterInput) SetCloudwatchLogsExportConfiguration 

func (s *ModifyDBClusterInput) SetCloudwatchLogsExportConfiguration(v *CloudwatchLogsExportConfiguration) *ModifyDBClusterInput

SetCloudwatchLogsExportConfiguration sets the CloudwatchLogsExportConfiguration field's value.

func (*ModifyDBClusterInput) SetDBClusterIdentifier 

func (s *ModifyDBClusterInput) SetDBClusterIdentifier(v string) *ModifyDBClusterInput

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*ModifyDBClusterInput) SetDBClusterParameterGroupName 

func (s *ModifyDBClusterInput) SetDBClusterParameterGroupName(v string) *ModifyDBClusterInput

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*ModifyDBClusterInput) SetDeletionProtection added in v1.20.13 

func (s *ModifyDBClusterInput) SetDeletionProtection(v bool) *ModifyDBClusterInput

SetDeletionProtection sets the DeletionProtection field's value.

func (*ModifyDBClusterInput) SetEngineVersion 

func (s *ModifyDBClusterInput) SetEngineVersion(v string) *ModifyDBClusterInput

SetEngineVersion sets the EngineVersion field's value.

func (*ModifyDBClusterInput) SetMasterUserPassword 

func (s *ModifyDBClusterInput) SetMasterUserPassword(v string) *ModifyDBClusterInput

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*ModifyDBClusterInput) SetNewDBClusterIdentifier 

func (s *ModifyDBClusterInput) SetNewDBClusterIdentifier(v string) *ModifyDBClusterInput

SetNewDBClusterIdentifier sets the NewDBClusterIdentifier field's value.

func (*ModifyDBClusterInput) SetPort 

func (s *ModifyDBClusterInput) SetPort(v int64) *ModifyDBClusterInput

SetPort sets the Port field's value.

func (*ModifyDBClusterInput) SetPreferredBackupWindow 

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*ModifyDBClusterInput) SetPreferredMaintenanceWindow 

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*ModifyDBClusterInput) SetStorageType added in v1.48.1 

func (s *ModifyDBClusterInput) SetStorageType(v string) *ModifyDBClusterInput

SetStorageType sets the StorageType field's value.

func (*ModifyDBClusterInput) SetVpcSecurityGroupIds 

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

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (ModifyDBClusterInput) String 

func (s ModifyDBClusterInput) 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 (*ModifyDBClusterInput) Validate 

func (s *ModifyDBClusterInput) Validate() error

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

type ModifyDBClusterOutput 

type ModifyDBClusterOutput struct {

	// Detailed information about a cluster.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyDBClusterOutput) GoString 

func (s ModifyDBClusterOutput) 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 (*ModifyDBClusterOutput) SetDBCluster 

func (s *ModifyDBClusterOutput) SetDBCluster(v *DBCluster) *ModifyDBClusterOutput

SetDBCluster sets the DBCluster field's value.

func (ModifyDBClusterOutput) String 

func (s ModifyDBClusterOutput) 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 ModifyDBClusterParameterGroupInput 

type ModifyDBClusterParameterGroupInput struct {

	// The name of the cluster parameter group to modify.
	//
	// DBClusterParameterGroupName is a required field
	DBClusterParameterGroupName *string `type:"string" required:"true"`

	// A list of parameters in the cluster parameter group to modify.
	//
	// Parameters is a required field
	Parameters []*Parameter `locationNameList:"Parameter" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to ModifyDBClusterParameterGroup.

func (ModifyDBClusterParameterGroupInput) GoString 

func (s ModifyDBClusterParameterGroupInput) 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 (*ModifyDBClusterParameterGroupInput) SetDBClusterParameterGroupName 

func (s *ModifyDBClusterParameterGroupInput) SetDBClusterParameterGroupName(v string) *ModifyDBClusterParameterGroupInput

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*ModifyDBClusterParameterGroupInput) SetParameters 

func (s *ModifyDBClusterParameterGroupInput) SetParameters(v []*Parameter) *ModifyDBClusterParameterGroupInput

SetParameters sets the Parameters field's value.

func (ModifyDBClusterParameterGroupInput) String 

func (s ModifyDBClusterParameterGroupInput) 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 (*ModifyDBClusterParameterGroupInput) Validate 

func (s *ModifyDBClusterParameterGroupInput) Validate() error

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

type ModifyDBClusterParameterGroupOutput 

type ModifyDBClusterParameterGroupOutput struct {

	// The name of a cluster parameter group.
	//
	// Constraints:
	//
	//    * Must be from 1 to 255 letters or numbers.
	//
	//    * The first character must be a letter.
	//
	//    * Cannot end with a hyphen or contain two consecutive hyphens.
	//
	// This value is stored as a lowercase string.
	DBClusterParameterGroupName *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the name of a cluster parameter group.

func (ModifyDBClusterParameterGroupOutput) GoString 

func (s ModifyDBClusterParameterGroupOutput) 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 (*ModifyDBClusterParameterGroupOutput) SetDBClusterParameterGroupName 

func (s *ModifyDBClusterParameterGroupOutput) SetDBClusterParameterGroupName(v string) *ModifyDBClusterParameterGroupOutput

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (ModifyDBClusterParameterGroupOutput) String 

func (s ModifyDBClusterParameterGroupOutput) 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 ModifyDBClusterSnapshotAttributeInput 

type ModifyDBClusterSnapshotAttributeInput struct {

	// The name of the cluster snapshot attribute to modify.
	//
	// To manage authorization for other Amazon Web Services accounts to copy or
	// restore a manual cluster snapshot, set this value to restore.
	//
	// AttributeName is a required field
	AttributeName *string `type:"string" required:"true"`

	// The identifier for the cluster snapshot to modify the attributes for.
	//
	// DBClusterSnapshotIdentifier is a required field
	DBClusterSnapshotIdentifier *string `type:"string" required:"true"`

	// A list of cluster snapshot attributes to add to the attribute specified by
	// AttributeName.
	//
	// To authorize other Amazon Web Services accounts to copy or restore a manual
	// cluster snapshot, set this list to include one or more Amazon Web Services
	// account IDs. To make the manual cluster snapshot restorable by any Amazon
	// Web Services account, set it to all. Do not add the all value for any manual
	// cluster snapshots that contain private information that you don't want to
	// be available to all Amazon Web Services accounts.
	ValuesToAdd []*string `locationNameList:"AttributeValue" type:"list"`

	// A list of cluster snapshot attributes to remove from the attribute specified
	// by AttributeName.
	//
	// To remove authorization for other Amazon Web Services accounts to copy or
	// restore a manual cluster snapshot, set this list to include one or more Amazon
	// Web Services account identifiers. To remove authorization for any Amazon
	// Web Services account to copy or restore the cluster snapshot, set it to all
	// . If you specify all, an Amazon Web Services account whose account ID is
	// explicitly added to the restore attribute can still copy or restore a manual
	// cluster snapshot.
	ValuesToRemove []*string `locationNameList:"AttributeValue" type:"list"`
	// contains filtered or unexported fields
}

Represents the input to ModifyDBClusterSnapshotAttribute.

func (ModifyDBClusterSnapshotAttributeInput) GoString 

func (s ModifyDBClusterSnapshotAttributeInput) 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 (*ModifyDBClusterSnapshotAttributeInput) SetAttributeName 

func (s *ModifyDBClusterSnapshotAttributeInput) SetAttributeName(v string) *ModifyDBClusterSnapshotAttributeInput

SetAttributeName sets the AttributeName field's value.

func (*ModifyDBClusterSnapshotAttributeInput) SetDBClusterSnapshotIdentifier 

func (s *ModifyDBClusterSnapshotAttributeInput) SetDBClusterSnapshotIdentifier(v string) *ModifyDBClusterSnapshotAttributeInput

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (*ModifyDBClusterSnapshotAttributeInput) SetValuesToAdd 

func (s *ModifyDBClusterSnapshotAttributeInput) SetValuesToAdd(v []*string) *ModifyDBClusterSnapshotAttributeInput

SetValuesToAdd sets the ValuesToAdd field's value.

func (*ModifyDBClusterSnapshotAttributeInput) SetValuesToRemove 

func (s *ModifyDBClusterSnapshotAttributeInput) SetValuesToRemove(v []*string) *ModifyDBClusterSnapshotAttributeInput

SetValuesToRemove sets the ValuesToRemove field's value.

func (ModifyDBClusterSnapshotAttributeInput) String 

func (s ModifyDBClusterSnapshotAttributeInput) 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 (*ModifyDBClusterSnapshotAttributeInput) Validate 

func (s *ModifyDBClusterSnapshotAttributeInput) Validate() error

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

type ModifyDBClusterSnapshotAttributeOutput 

type ModifyDBClusterSnapshotAttributeOutput struct {

	// Detailed information about the attributes that are associated with a cluster
	// snapshot.
	DBClusterSnapshotAttributesResult *DBClusterSnapshotAttributesResult `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyDBClusterSnapshotAttributeOutput) GoString 

func (s ModifyDBClusterSnapshotAttributeOutput) 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 (*ModifyDBClusterSnapshotAttributeOutput) SetDBClusterSnapshotAttributesResult 

func (s *ModifyDBClusterSnapshotAttributeOutput) SetDBClusterSnapshotAttributesResult(v *DBClusterSnapshotAttributesResult) *ModifyDBClusterSnapshotAttributeOutput

SetDBClusterSnapshotAttributesResult sets the DBClusterSnapshotAttributesResult field's value.

func (ModifyDBClusterSnapshotAttributeOutput) String 

func (s ModifyDBClusterSnapshotAttributeOutput) 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 ModifyDBInstanceInput 

type ModifyDBInstanceInput struct {

	// Specifies whether the modifications in this request and any pending modifications
	// are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow
	// setting for the instance.
	//
	// If this parameter is set to false, changes to the instance are applied during
	// the next maintenance window. Some parameter changes can cause an outage and
	// are applied on the next reboot.
	//
	// Default: false
	ApplyImmediately *bool `type:"boolean"`

	// This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does
	// not perform minor version upgrades regardless of the value set.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// Indicates the certificate that needs to be associated with the instance.
	CACertificateIdentifier *string `type:"string"`

	// Specifies whether the DB instance is restarted when you rotate your SSL/TLS
	// certificate.
	//
	// By default, the DB instance is restarted when you rotate your SSL/TLS certificate.
	// The certificate is not updated until the DB instance is restarted.
	//
	// Set this parameter only if you are not using SSL/TLS to connect to the DB
	// instance.
	//
	// If you are using SSL/TLS to connect to the DB instance, see Updating Your
	// Amazon DocumentDB TLS Certificates (https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html)
	// and Encrypting Data in Transit (https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)
	// in the Amazon DocumentDB Developer Guide.
	CertificateRotationRestart *bool `type:"boolean"`

	// A value that indicates whether to copy all tags from the DB instance to snapshots
	// of the DB instance. By default, tags are not copied.
	CopyTagsToSnapshot *bool `type:"boolean"`

	// The new compute and memory capacity of the instance; for example, db.r5.large.
	// Not all instance classes are available in all Amazon Web Services Regions.
	//
	// If you modify the instance class, an outage occurs during the change. The
	// change is applied during the next maintenance window, unless ApplyImmediately
	// is specified as true for this request.
	//
	// Default: Uses existing setting.
	DBInstanceClass *string `type:"string"`

	// The instance identifier. This value is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBInstance.
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// A value that indicates whether to enable Performance Insights for the DB
	// Instance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html).
	EnablePerformanceInsights *bool `type:"boolean"`

	// The new instance identifier for the instance when renaming an instance. When
	// you change the instance identifier, an instance reboot occurs immediately
	// if you set Apply Immediately to true. It occurs during the next maintenance
	// window if you set Apply Immediately to false. This value 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: mydbinstance
	NewDBInstanceIdentifier *string `type:"string"`

	// The KMS key identifier for encryption of Performance Insights data.
	//
	// The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for
	// the KMS key.
	//
	// If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon
	// DocumentDB uses your default KMS key. There is a default KMS key for your
	// Amazon Web Services account. Your Amazon Web Services account has a different
	// default KMS key for each Amazon Web Services region.
	PerformanceInsightsKMSKeyId *string `type:"string"`

	// The weekly time range (in UTC) during which system maintenance can occur,
	// which might result in an outage. Changing this parameter doesn't result in
	// an outage except in the following situation, and the change is asynchronously
	// applied as soon as possible. If there are pending actions that cause a reboot,
	// and the maintenance window is changed to include the current time, changing
	// this parameter causes a reboot of the instance. If you are moving this window
	// to the current time, there must be at least 30 minutes between the current
	// time and end of the window to ensure that pending changes are applied.
	//
	// Default: Uses existing setting.
	//
	// Format: ddd:hh24:mi-ddd:hh24:mi
	//
	// Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
	//
	// Constraints: Must be at least 30 minutes.
	PreferredMaintenanceWindow *string `type:"string"`

	// A value that specifies the order in which an Amazon DocumentDB replica is
	// promoted to the primary instance after a failure of the existing primary
	// instance.
	//
	// Default: 1
	//
	// Valid values: 0-15
	PromotionTier *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Represents the input to ModifyDBInstance.

func (ModifyDBInstanceInput) GoString 

func (s ModifyDBInstanceInput) 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 (*ModifyDBInstanceInput) SetApplyImmediately 

func (s *ModifyDBInstanceInput) SetApplyImmediately(v bool) *ModifyDBInstanceInput

SetApplyImmediately sets the ApplyImmediately field's value.

func (*ModifyDBInstanceInput) SetAutoMinorVersionUpgrade 

func (s *ModifyDBInstanceInput) SetAutoMinorVersionUpgrade(v bool) *ModifyDBInstanceInput

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*ModifyDBInstanceInput) SetCACertificateIdentifier added in v1.25.3 

func (s *ModifyDBInstanceInput) SetCACertificateIdentifier(v string) *ModifyDBInstanceInput

SetCACertificateIdentifier sets the CACertificateIdentifier field's value.

func (*ModifyDBInstanceInput) SetCertificateRotationRestart added in v1.47.4 

func (s *ModifyDBInstanceInput) SetCertificateRotationRestart(v bool) *ModifyDBInstanceInput

SetCertificateRotationRestart sets the CertificateRotationRestart field's value.

func (*ModifyDBInstanceInput) SetCopyTagsToSnapshot added in v1.44.60 

func (s *ModifyDBInstanceInput) SetCopyTagsToSnapshot(v bool) *ModifyDBInstanceInput

SetCopyTagsToSnapshot sets the CopyTagsToSnapshot field's value.

func (*ModifyDBInstanceInput) SetDBInstanceClass 

func (s *ModifyDBInstanceInput) SetDBInstanceClass(v string) *ModifyDBInstanceInput

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*ModifyDBInstanceInput) SetDBInstanceIdentifier 

func (s *ModifyDBInstanceInput) SetDBInstanceIdentifier(v string) *ModifyDBInstanceInput

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*ModifyDBInstanceInput) SetEnablePerformanceInsights added in v1.43.35 

func (s *ModifyDBInstanceInput) SetEnablePerformanceInsights(v bool) *ModifyDBInstanceInput

SetEnablePerformanceInsights sets the EnablePerformanceInsights field's value.

func (*ModifyDBInstanceInput) SetNewDBInstanceIdentifier 

func (s *ModifyDBInstanceInput) SetNewDBInstanceIdentifier(v string) *ModifyDBInstanceInput

SetNewDBInstanceIdentifier sets the NewDBInstanceIdentifier field's value.

func (*ModifyDBInstanceInput) SetPerformanceInsightsKMSKeyId added in v1.43.35 

func (s *ModifyDBInstanceInput) SetPerformanceInsightsKMSKeyId(v string) *ModifyDBInstanceInput

SetPerformanceInsightsKMSKeyId sets the PerformanceInsightsKMSKeyId field's value.

func (*ModifyDBInstanceInput) SetPreferredMaintenanceWindow 

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*ModifyDBInstanceInput) SetPromotionTier 

func (s *ModifyDBInstanceInput) SetPromotionTier(v int64) *ModifyDBInstanceInput

SetPromotionTier sets the PromotionTier field's value.

func (ModifyDBInstanceInput) String 

func (s ModifyDBInstanceInput) 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 (*ModifyDBInstanceInput) Validate 

func (s *ModifyDBInstanceInput) Validate() error

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

type ModifyDBInstanceOutput 

type ModifyDBInstanceOutput struct {

	// Detailed information about an instance.
	DBInstance *DBInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyDBInstanceOutput) GoString 

func (s ModifyDBInstanceOutput) 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 (*ModifyDBInstanceOutput) SetDBInstance 

func (s *ModifyDBInstanceOutput) SetDBInstance(v *DBInstance) *ModifyDBInstanceOutput

SetDBInstance sets the DBInstance field's value.

func (ModifyDBInstanceOutput) String 

func (s ModifyDBInstanceOutput) 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 ModifyDBSubnetGroupInput 

type ModifyDBSubnetGroupInput struct {

	// The description for the subnet group.
	DBSubnetGroupDescription *string `type:"string"`

	// The name for the subnet group. This value is stored as a lowercase string.
	// You can't modify the default subnet group.
	//
	// Constraints: Must match the name of an existing DBSubnetGroup. Must not be
	// default.
	//
	// Example: mySubnetgroup
	//
	// DBSubnetGroupName is a required field
	DBSubnetGroupName *string `type:"string" required:"true"`

	// The Amazon EC2 subnet IDs for the subnet group.
	//
	// SubnetIds is a required field
	SubnetIds []*string `locationNameList:"SubnetIdentifier" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to ModifyDBSubnetGroup.

func (ModifyDBSubnetGroupInput) GoString 

func (s ModifyDBSubnetGroupInput) 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 (*ModifyDBSubnetGroupInput) SetDBSubnetGroupDescription 

func (s *ModifyDBSubnetGroupInput) SetDBSubnetGroupDescription(v string) *ModifyDBSubnetGroupInput

SetDBSubnetGroupDescription sets the DBSubnetGroupDescription field's value.

func (*ModifyDBSubnetGroupInput) SetDBSubnetGroupName 

func (s *ModifyDBSubnetGroupInput) SetDBSubnetGroupName(v string) *ModifyDBSubnetGroupInput

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*ModifyDBSubnetGroupInput) SetSubnetIds 

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

SetSubnetIds sets the SubnetIds field's value.

func (ModifyDBSubnetGroupInput) String 

func (s ModifyDBSubnetGroupInput) 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 (*ModifyDBSubnetGroupInput) Validate 

func (s *ModifyDBSubnetGroupInput) Validate() error

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

type ModifyDBSubnetGroupOutput 

type ModifyDBSubnetGroupOutput struct {

	// Detailed information about a subnet group.
	DBSubnetGroup *DBSubnetGroup `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyDBSubnetGroupOutput) GoString 

func (s ModifyDBSubnetGroupOutput) 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 (*ModifyDBSubnetGroupOutput) SetDBSubnetGroup 

func (s *ModifyDBSubnetGroupOutput) SetDBSubnetGroup(v *DBSubnetGroup) *ModifyDBSubnetGroupOutput

SetDBSubnetGroup sets the DBSubnetGroup field's value.

func (ModifyDBSubnetGroupOutput) String 

func (s ModifyDBSubnetGroupOutput) 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 ModifyEventSubscriptionInput added in v1.38.8 

type ModifyEventSubscriptionInput struct {

	// A Boolean value; set to true to activate the subscription.
	Enabled *bool `type:"boolean"`

	// A list of event categories for a SourceType that you want to subscribe to.
	EventCategories []*string `locationNameList:"EventCategory" type:"list"`

	// The Amazon Resource Name (ARN) of the SNS topic created for event notification.
	// The ARN is created by Amazon SNS when you create a topic and subscribe to
	// it.
	SnsTopicArn *string `type:"string"`

	// The type of source that is generating the events. For example, if you want
	// to be notified of events generated by an instance, set this parameter to
	// db-instance. If this value is not specified, all events are returned.
	//
	// Valid values: db-instance, db-parameter-group, db-security-group
	SourceType *string `type:"string"`

	// The name of the Amazon DocumentDB event notification subscription.
	//
	// SubscriptionName is a required field
	SubscriptionName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to ModifyEventSubscription.

func (ModifyEventSubscriptionInput) GoString added in v1.38.8 

func (s ModifyEventSubscriptionInput) 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 (*ModifyEventSubscriptionInput) SetEnabled added in v1.38.8 

func (s *ModifyEventSubscriptionInput) SetEnabled(v bool) *ModifyEventSubscriptionInput

SetEnabled sets the Enabled field's value.

func (*ModifyEventSubscriptionInput) SetEventCategories added in v1.38.8 

func (s *ModifyEventSubscriptionInput) SetEventCategories(v []*string) *ModifyEventSubscriptionInput

SetEventCategories sets the EventCategories field's value.

func (*ModifyEventSubscriptionInput) SetSnsTopicArn added in v1.38.8 

func (s *ModifyEventSubscriptionInput) SetSnsTopicArn(v string) *ModifyEventSubscriptionInput

SetSnsTopicArn sets the SnsTopicArn field's value.

func (*ModifyEventSubscriptionInput) SetSourceType added in v1.38.8 

func (s *ModifyEventSubscriptionInput) SetSourceType(v string) *ModifyEventSubscriptionInput

SetSourceType sets the SourceType field's value.

func (*ModifyEventSubscriptionInput) SetSubscriptionName added in v1.38.8 

func (s *ModifyEventSubscriptionInput) SetSubscriptionName(v string) *ModifyEventSubscriptionInput

SetSubscriptionName sets the SubscriptionName field's value.

func (ModifyEventSubscriptionInput) String added in v1.38.8 

func (s ModifyEventSubscriptionInput) 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 (*ModifyEventSubscriptionInput) Validate added in v1.38.8 

func (s *ModifyEventSubscriptionInput) Validate() error

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

type ModifyEventSubscriptionOutput added in v1.38.8 

type ModifyEventSubscriptionOutput struct {

	// Detailed information about an event to which you have subscribed.
	EventSubscription *EventSubscription `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyEventSubscriptionOutput) GoString added in v1.38.8 

func (s ModifyEventSubscriptionOutput) 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 (*ModifyEventSubscriptionOutput) SetEventSubscription added in v1.38.8 

func (s *ModifyEventSubscriptionOutput) SetEventSubscription(v *EventSubscription) *ModifyEventSubscriptionOutput

SetEventSubscription sets the EventSubscription field's value.

func (ModifyEventSubscriptionOutput) String added in v1.38.8 

func (s ModifyEventSubscriptionOutput) 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 ModifyGlobalClusterInput added in v1.38.53 

type ModifyGlobalClusterInput struct {

	// Indicates if the global cluster has deletion protection enabled. The global
	// cluster can't be deleted when deletion protection is enabled.
	DeletionProtection *bool `type:"boolean"`

	// The identifier for the global cluster being modified. This parameter isn't
	// case-sensitive.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing global cluster.
	//
	// GlobalClusterIdentifier is a required field
	GlobalClusterIdentifier *string `min:"1" type:"string" required:"true"`

	// The new identifier for a global cluster when you modify a global cluster.
	// This value is stored as a lowercase string.
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens The first character
	//    must be a letter Can't end with a hyphen or contain two consecutive hyphens
	//
	// Example: my-cluster2
	NewGlobalClusterIdentifier *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents the input to ModifyGlobalCluster.

func (ModifyGlobalClusterInput) GoString added in v1.38.53 

func (s ModifyGlobalClusterInput) 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 (*ModifyGlobalClusterInput) SetDeletionProtection added in v1.38.53 

func (s *ModifyGlobalClusterInput) SetDeletionProtection(v bool) *ModifyGlobalClusterInput

SetDeletionProtection sets the DeletionProtection field's value.

func (*ModifyGlobalClusterInput) SetGlobalClusterIdentifier added in v1.38.53 

func (s *ModifyGlobalClusterInput) SetGlobalClusterIdentifier(v string) *ModifyGlobalClusterInput

SetGlobalClusterIdentifier sets the GlobalClusterIdentifier field's value.

func (*ModifyGlobalClusterInput) SetNewGlobalClusterIdentifier added in v1.38.53 

func (s *ModifyGlobalClusterInput) SetNewGlobalClusterIdentifier(v string) *ModifyGlobalClusterInput

SetNewGlobalClusterIdentifier sets the NewGlobalClusterIdentifier field's value.

func (ModifyGlobalClusterInput) String added in v1.38.53 

func (s ModifyGlobalClusterInput) 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 (*ModifyGlobalClusterInput) Validate added in v1.38.53 

func (s *ModifyGlobalClusterInput) Validate() error

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

type ModifyGlobalClusterOutput added in v1.38.53 

type ModifyGlobalClusterOutput struct {

	// A data type representing an Amazon DocumentDB global cluster.
	GlobalCluster *GlobalCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (ModifyGlobalClusterOutput) GoString added in v1.38.53 

func (s ModifyGlobalClusterOutput) 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 (*ModifyGlobalClusterOutput) SetGlobalCluster added in v1.38.53 

func (s *ModifyGlobalClusterOutput) SetGlobalCluster(v *GlobalCluster) *ModifyGlobalClusterOutput

SetGlobalCluster sets the GlobalCluster field's value.

func (ModifyGlobalClusterOutput) String added in v1.38.53 

func (s ModifyGlobalClusterOutput) 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 OrderableDBInstanceOption 

type OrderableDBInstanceOption struct {

	// A list of Availability Zones for an instance.
	AvailabilityZones []*AvailabilityZone `locationNameList:"AvailabilityZone" type:"list"`

	// The instance class for an instance.
	DBInstanceClass *string `type:"string"`

	// The engine type of an instance.
	Engine *string `type:"string"`

	// The engine version of an instance.
	EngineVersion *string `type:"string"`

	// The license model for an instance.
	LicenseModel *string `type:"string"`

	// The storage type to associate with the DB cluster
	StorageType *string `type:"string"`

	// Indicates whether an instance is in a virtual private cloud (VPC).
	Vpc *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The options that are available for an instance.

func (OrderableDBInstanceOption) GoString 

func (s OrderableDBInstanceOption) 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 (*OrderableDBInstanceOption) SetAvailabilityZones 

func (s *OrderableDBInstanceOption) SetAvailabilityZones(v []*AvailabilityZone) *OrderableDBInstanceOption

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*OrderableDBInstanceOption) SetDBInstanceClass 

func (s *OrderableDBInstanceOption) SetDBInstanceClass(v string) *OrderableDBInstanceOption

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*OrderableDBInstanceOption) SetEngine 

func (s *OrderableDBInstanceOption) SetEngine(v string) *OrderableDBInstanceOption

SetEngine sets the Engine field's value.

func (*OrderableDBInstanceOption) SetEngineVersion 

func (s *OrderableDBInstanceOption) SetEngineVersion(v string) *OrderableDBInstanceOption

SetEngineVersion sets the EngineVersion field's value.

func (*OrderableDBInstanceOption) SetLicenseModel 

func (s *OrderableDBInstanceOption) SetLicenseModel(v string) *OrderableDBInstanceOption

SetLicenseModel sets the LicenseModel field's value.

func (*OrderableDBInstanceOption) SetStorageType added in v1.48.1 

func (s *OrderableDBInstanceOption) SetStorageType(v string) *OrderableDBInstanceOption

SetStorageType sets the StorageType field's value.

func (*OrderableDBInstanceOption) SetVpc 

func (s *OrderableDBInstanceOption) SetVpc(v bool) *OrderableDBInstanceOption

SetVpc sets the Vpc field's value.

func (OrderableDBInstanceOption) String 

func (s OrderableDBInstanceOption) 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 Parameter 

type Parameter struct {

	// Specifies the valid range of values for the parameter.
	AllowedValues *string `type:"string"`

	// Indicates when to apply parameter updates.
	ApplyMethod *string `type:"string" enum:"ApplyMethod"`

	// Specifies the engine-specific parameters type.
	ApplyType *string `type:"string"`

	// Specifies the valid data type for the parameter.
	DataType *string `type:"string"`

	// Provides a description of the parameter.
	Description *string `type:"string"`

	// Indicates whether (true) or not (false) the parameter can be modified. Some
	// parameters have security or operational implications that prevent them from
	// being changed.
	IsModifiable *bool `type:"boolean"`

	// The earliest engine version to which the parameter can apply.
	MinimumEngineVersion *string `type:"string"`

	// Specifies the name of the parameter.
	ParameterName *string `type:"string"`

	// Specifies the value of the parameter.
	ParameterValue *string `type:"string"`

	// Indicates the source of the parameter value.
	Source *string `type:"string"`
	// contains filtered or unexported fields
}

Detailed information about an individual parameter.

func (Parameter) GoString 

func (s Parameter) 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 (*Parameter) SetAllowedValues 

func (s *Parameter) SetAllowedValues(v string) *Parameter

SetAllowedValues sets the AllowedValues field's value.

func (*Parameter) SetApplyMethod 

func (s *Parameter) SetApplyMethod(v string) *Parameter

SetApplyMethod sets the ApplyMethod field's value.

func (*Parameter) SetApplyType 

func (s *Parameter) SetApplyType(v string) *Parameter

SetApplyType sets the ApplyType field's value.

func (*Parameter) SetDataType 

func (s *Parameter) SetDataType(v string) *Parameter

SetDataType sets the DataType field's value.

func (*Parameter) SetDescription 

func (s *Parameter) SetDescription(v string) *Parameter

SetDescription sets the Description field's value.

func (*Parameter) SetIsModifiable 

func (s *Parameter) SetIsModifiable(v bool) *Parameter

SetIsModifiable sets the IsModifiable field's value.

func (*Parameter) SetMinimumEngineVersion 

func (s *Parameter) SetMinimumEngineVersion(v string) *Parameter

SetMinimumEngineVersion sets the MinimumEngineVersion field's value.

func (*Parameter) SetParameterName 

func (s *Parameter) SetParameterName(v string) *Parameter

SetParameterName sets the ParameterName field's value.

func (*Parameter) SetParameterValue 

func (s *Parameter) SetParameterValue(v string) *Parameter

SetParameterValue sets the ParameterValue field's value.

func (*Parameter) SetSource 

func (s *Parameter) SetSource(v string) *Parameter

SetSource sets the Source field's value.

func (Parameter) String 

func (s Parameter) 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 PendingCloudwatchLogsExports 

type PendingCloudwatchLogsExports struct {

	// Log types that are in the process of being enabled. After they are enabled,
	// these log types are exported to Amazon CloudWatch Logs.
	LogTypesToDisable []*string `type:"list"`

	// Log types that are in the process of being deactivated. After they are deactivated,
	// these log types aren't exported to CloudWatch Logs.
	LogTypesToEnable []*string `type:"list"`
	// contains filtered or unexported fields
}

A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

func (PendingCloudwatchLogsExports) GoString 

func (s PendingCloudwatchLogsExports) 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 (*PendingCloudwatchLogsExports) SetLogTypesToDisable 

func (s *PendingCloudwatchLogsExports) SetLogTypesToDisable(v []*string) *PendingCloudwatchLogsExports

SetLogTypesToDisable sets the LogTypesToDisable field's value.

func (*PendingCloudwatchLogsExports) SetLogTypesToEnable 

func (s *PendingCloudwatchLogsExports) SetLogTypesToEnable(v []*string) *PendingCloudwatchLogsExports

SetLogTypesToEnable sets the LogTypesToEnable field's value.

func (PendingCloudwatchLogsExports) String 

func (s PendingCloudwatchLogsExports) 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 PendingMaintenanceAction 

type PendingMaintenanceAction struct {

	// The type of pending maintenance action that is available for the resource.
	Action *string `type:"string"`

	// The date of the maintenance window when the action is applied. The maintenance
	// action is applied to the resource during its first maintenance window after
	// this date. If this date is specified, any next-maintenance opt-in requests
	// are ignored.
	AutoAppliedAfterDate *time.Time `type:"timestamp"`

	// The effective date when the pending maintenance action is applied to the
	// resource.
	CurrentApplyDate *time.Time `type:"timestamp"`

	// A description providing more detail about the maintenance action.
	Description *string `type:"string"`

	// The date when the maintenance action is automatically applied. The maintenance
	// action is applied to the resource on this date regardless of the maintenance
	// window for the resource. If this date is specified, any immediate opt-in
	// requests are ignored.
	ForcedApplyDate *time.Time `type:"timestamp"`

	// Indicates the type of opt-in request that has been received for the resource.
	OptInStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a pending maintenance action for a resource.

func (PendingMaintenanceAction) GoString 

func (s PendingMaintenanceAction) 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 (*PendingMaintenanceAction) SetAction 

func (s *PendingMaintenanceAction) SetAction(v string) *PendingMaintenanceAction

SetAction sets the Action field's value.

func (*PendingMaintenanceAction) SetAutoAppliedAfterDate 

func (s *PendingMaintenanceAction) SetAutoAppliedAfterDate(v time.Time) *PendingMaintenanceAction

SetAutoAppliedAfterDate sets the AutoAppliedAfterDate field's value.

func (*PendingMaintenanceAction) SetCurrentApplyDate 

func (s *PendingMaintenanceAction) SetCurrentApplyDate(v time.Time) *PendingMaintenanceAction

SetCurrentApplyDate sets the CurrentApplyDate field's value.

func (*PendingMaintenanceAction) SetDescription 

func (s *PendingMaintenanceAction) SetDescription(v string) *PendingMaintenanceAction

SetDescription sets the Description field's value.

func (*PendingMaintenanceAction) SetForcedApplyDate 

func (s *PendingMaintenanceAction) SetForcedApplyDate(v time.Time) *PendingMaintenanceAction

SetForcedApplyDate sets the ForcedApplyDate field's value.

func (*PendingMaintenanceAction) SetOptInStatus 

func (s *PendingMaintenanceAction) SetOptInStatus(v string) *PendingMaintenanceAction

SetOptInStatus sets the OptInStatus field's value.

func (PendingMaintenanceAction) String 

func (s PendingMaintenanceAction) 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 PendingModifiedValues 

type PendingModifiedValues struct {

	// Contains the new AllocatedStorage size for then instance that will be applied
	// or is currently being applied.
	AllocatedStorage *int64 `type:"integer"`

	// Specifies the pending number of days for which automated backups are retained.
	BackupRetentionPeriod *int64 `type:"integer"`

	// Specifies the identifier of the certificate authority (CA) certificate for
	// the DB instance.
	CACertificateIdentifier *string `type:"string"`

	// Contains the new DBInstanceClass for the instance that will be applied or
	// is currently being applied.
	DBInstanceClass *string `type:"string"`

	// Contains the new DBInstanceIdentifier for the instance that will be applied
	// or is currently being applied.
	DBInstanceIdentifier *string `type:"string"`

	// The new subnet group for the instance.
	DBSubnetGroupName *string `type:"string"`

	// Indicates the database engine version.
	EngineVersion *string `type:"string"`

	// Specifies the new Provisioned IOPS value for the instance that will be applied
	// or is currently being applied.
	Iops *int64 `type:"integer"`

	// The license model for the instance.
	//
	// Valid values: license-included, bring-your-own-license, general-public-license
	LicenseModel *string `type:"string"`

	// Contains the pending or currently in-progress change of the master credentials
	// for the instance.
	MasterUserPassword *string `type:"string"`

	// Indicates that the Single-AZ instance is to change to a Multi-AZ deployment.
	MultiAZ *bool `type:"boolean"`

	// A list of the log types whose configuration is still pending. These log types
	// are in the process of being activated or deactivated.
	PendingCloudwatchLogsExports *PendingCloudwatchLogsExports `type:"structure"`

	// Specifies the pending port for the instance.
	Port *int64 `type:"integer"`

	// Specifies the storage type to be associated with the instance.
	StorageType *string `type:"string"`
	// contains filtered or unexported fields
}

One or more modified settings for an instance. These modified settings have been requested, but haven't been applied yet.

func (PendingModifiedValues) GoString 

func (s PendingModifiedValues) 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 (*PendingModifiedValues) SetAllocatedStorage 

func (s *PendingModifiedValues) SetAllocatedStorage(v int64) *PendingModifiedValues

SetAllocatedStorage sets the AllocatedStorage field's value.

func (*PendingModifiedValues) SetBackupRetentionPeriod 

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*PendingModifiedValues) SetCACertificateIdentifier 

func (s *PendingModifiedValues) SetCACertificateIdentifier(v string) *PendingModifiedValues

SetCACertificateIdentifier sets the CACertificateIdentifier field's value.

func (*PendingModifiedValues) SetDBInstanceClass 

func (s *PendingModifiedValues) SetDBInstanceClass(v string) *PendingModifiedValues

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*PendingModifiedValues) SetDBInstanceIdentifier 

func (s *PendingModifiedValues) SetDBInstanceIdentifier(v string) *PendingModifiedValues

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*PendingModifiedValues) SetDBSubnetGroupName 

func (s *PendingModifiedValues) SetDBSubnetGroupName(v string) *PendingModifiedValues

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*PendingModifiedValues) SetEngineVersion 

func (s *PendingModifiedValues) SetEngineVersion(v string) *PendingModifiedValues

SetEngineVersion sets the EngineVersion field's value.

func (*PendingModifiedValues) SetIops 

func (s *PendingModifiedValues) SetIops(v int64) *PendingModifiedValues

SetIops sets the Iops field's value.

func (*PendingModifiedValues) SetLicenseModel 

func (s *PendingModifiedValues) SetLicenseModel(v string) *PendingModifiedValues

SetLicenseModel sets the LicenseModel field's value.

func (*PendingModifiedValues) SetMasterUserPassword 

func (s *PendingModifiedValues) SetMasterUserPassword(v string) *PendingModifiedValues

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*PendingModifiedValues) SetMultiAZ 

func (s *PendingModifiedValues) SetMultiAZ(v bool) *PendingModifiedValues

SetMultiAZ sets the MultiAZ field's value.

func (*PendingModifiedValues) SetPendingCloudwatchLogsExports 

func (s *PendingModifiedValues) SetPendingCloudwatchLogsExports(v *PendingCloudwatchLogsExports) *PendingModifiedValues

SetPendingCloudwatchLogsExports sets the PendingCloudwatchLogsExports field's value.

func (*PendingModifiedValues) SetPort 

func (s *PendingModifiedValues) SetPort(v int64) *PendingModifiedValues

SetPort sets the Port field's value.

func (*PendingModifiedValues) SetStorageType 

func (s *PendingModifiedValues) SetStorageType(v string) *PendingModifiedValues

SetStorageType sets the StorageType field's value.

func (PendingModifiedValues) String 

func (s PendingModifiedValues) 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 RebootDBInstanceInput 

type RebootDBInstanceInput struct {

	// The instance identifier. This parameter is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBInstance.
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// When true, the reboot is conducted through a Multi-AZ failover.
	//
	// Constraint: You can't specify true if the instance is not configured for
	// Multi-AZ.
	ForceFailover *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Represents the input to RebootDBInstance.

func (RebootDBInstanceInput) GoString 

func (s RebootDBInstanceInput) 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 (*RebootDBInstanceInput) SetDBInstanceIdentifier 

func (s *RebootDBInstanceInput) SetDBInstanceIdentifier(v string) *RebootDBInstanceInput

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*RebootDBInstanceInput) SetForceFailover 

func (s *RebootDBInstanceInput) SetForceFailover(v bool) *RebootDBInstanceInput

SetForceFailover sets the ForceFailover field's value.

func (RebootDBInstanceInput) String 

func (s RebootDBInstanceInput) 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 (*RebootDBInstanceInput) Validate 

func (s *RebootDBInstanceInput) Validate() error

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

type RebootDBInstanceOutput 

type RebootDBInstanceOutput struct {

	// Detailed information about an instance.
	DBInstance *DBInstance `type:"structure"`
	// contains filtered or unexported fields
}

func (RebootDBInstanceOutput) GoString 

func (s RebootDBInstanceOutput) 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 (*RebootDBInstanceOutput) SetDBInstance 

func (s *RebootDBInstanceOutput) SetDBInstance(v *DBInstance) *RebootDBInstanceOutput

SetDBInstance sets the DBInstance field's value.

func (RebootDBInstanceOutput) String 

func (s RebootDBInstanceOutput) 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 RemoveFromGlobalClusterInput added in v1.38.53 

type RemoveFromGlobalClusterInput struct {

	// The Amazon Resource Name (ARN) identifying the cluster that was detached
	// from the Amazon DocumentDB global cluster.
	//
	// DbClusterIdentifier is a required field
	DbClusterIdentifier *string `type:"string" required:"true"`

	// The cluster identifier to detach from the Amazon DocumentDB global cluster.
	//
	// GlobalClusterIdentifier is a required field
	GlobalClusterIdentifier *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to RemoveFromGlobalCluster.

func (RemoveFromGlobalClusterInput) GoString added in v1.38.53 

func (s RemoveFromGlobalClusterInput) 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 (*RemoveFromGlobalClusterInput) SetDbClusterIdentifier added in v1.38.53 

func (s *RemoveFromGlobalClusterInput) SetDbClusterIdentifier(v string) *RemoveFromGlobalClusterInput

SetDbClusterIdentifier sets the DbClusterIdentifier field's value.

func (*RemoveFromGlobalClusterInput) SetGlobalClusterIdentifier added in v1.38.53 

func (s *RemoveFromGlobalClusterInput) SetGlobalClusterIdentifier(v string) *RemoveFromGlobalClusterInput

SetGlobalClusterIdentifier sets the GlobalClusterIdentifier field's value.

func (RemoveFromGlobalClusterInput) String added in v1.38.53 

func (s RemoveFromGlobalClusterInput) 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 (*RemoveFromGlobalClusterInput) Validate added in v1.38.53 

func (s *RemoveFromGlobalClusterInput) Validate() error

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

type RemoveFromGlobalClusterOutput added in v1.38.53 

type RemoveFromGlobalClusterOutput struct {

	// A data type representing an Amazon DocumentDB global cluster.
	GlobalCluster *GlobalCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (RemoveFromGlobalClusterOutput) GoString added in v1.38.53 

func (s RemoveFromGlobalClusterOutput) 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 (*RemoveFromGlobalClusterOutput) SetGlobalCluster added in v1.38.53 

func (s *RemoveFromGlobalClusterOutput) SetGlobalCluster(v *GlobalCluster) *RemoveFromGlobalClusterOutput

SetGlobalCluster sets the GlobalCluster field's value.

func (RemoveFromGlobalClusterOutput) String added in v1.38.53 

func (s RemoveFromGlobalClusterOutput) 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 RemoveSourceIdentifierFromSubscriptionInput added in v1.38.8 

type RemoveSourceIdentifierFromSubscriptionInput struct {

	// The source identifier to be removed from the subscription, such as the instance
	// identifier for an instance, or the name of a security group.
	//
	// SourceIdentifier is a required field
	SourceIdentifier *string `type:"string" required:"true"`

	// The name of the Amazon DocumentDB event notification subscription that you
	// want to remove a source identifier from.
	//
	// SubscriptionName is a required field
	SubscriptionName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to RemoveSourceIdentifierFromSubscription.

func (RemoveSourceIdentifierFromSubscriptionInput) GoString added in v1.38.8 

func (s RemoveSourceIdentifierFromSubscriptionInput) 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 (*RemoveSourceIdentifierFromSubscriptionInput) SetSourceIdentifier added in v1.38.8 

func (s *RemoveSourceIdentifierFromSubscriptionInput) SetSourceIdentifier(v string) *RemoveSourceIdentifierFromSubscriptionInput

SetSourceIdentifier sets the SourceIdentifier field's value.

func (*RemoveSourceIdentifierFromSubscriptionInput) SetSubscriptionName added in v1.38.8 

func (s *RemoveSourceIdentifierFromSubscriptionInput) SetSubscriptionName(v string) *RemoveSourceIdentifierFromSubscriptionInput

SetSubscriptionName sets the SubscriptionName field's value.

func (RemoveSourceIdentifierFromSubscriptionInput) String added in v1.38.8 

func (s RemoveSourceIdentifierFromSubscriptionInput) 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 (*RemoveSourceIdentifierFromSubscriptionInput) Validate added in v1.38.8 

func (s *RemoveSourceIdentifierFromSubscriptionInput) Validate() error

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

type RemoveSourceIdentifierFromSubscriptionOutput added in v1.38.8 

type RemoveSourceIdentifierFromSubscriptionOutput struct {

	// Detailed information about an event to which you have subscribed.
	EventSubscription *EventSubscription `type:"structure"`
	// contains filtered or unexported fields
}

func (RemoveSourceIdentifierFromSubscriptionOutput) GoString added in v1.38.8 

func (s RemoveSourceIdentifierFromSubscriptionOutput) 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 (*RemoveSourceIdentifierFromSubscriptionOutput) SetEventSubscription added in v1.38.8 

func (s *RemoveSourceIdentifierFromSubscriptionOutput) SetEventSubscription(v *EventSubscription) *RemoveSourceIdentifierFromSubscriptionOutput

SetEventSubscription sets the EventSubscription field's value.

func (RemoveSourceIdentifierFromSubscriptionOutput) String added in v1.38.8 

func (s RemoveSourceIdentifierFromSubscriptionOutput) 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 RemoveTagsFromResourceInput 

type RemoveTagsFromResourceInput struct {

	// The Amazon DocumentDB resource that the tags are removed from. This value
	// is an Amazon Resource Name (ARN).
	//
	// ResourceName is a required field
	ResourceName *string `type:"string" required:"true"`

	// The tag key (name) of the tag to be removed.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to RemoveTagsFromResource.

func (RemoveTagsFromResourceInput) GoString 

func (s RemoveTagsFromResourceInput) 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 (*RemoveTagsFromResourceInput) SetResourceName 

func (s *RemoveTagsFromResourceInput) SetResourceName(v string) *RemoveTagsFromResourceInput

SetResourceName sets the ResourceName field's value.

func (*RemoveTagsFromResourceInput) SetTagKeys 

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

SetTagKeys sets the TagKeys field's value.

func (RemoveTagsFromResourceInput) String 

func (s RemoveTagsFromResourceInput) 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 (*RemoveTagsFromResourceInput) Validate 

func (s *RemoveTagsFromResourceInput) Validate() error

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

type RemoveTagsFromResourceOutput 

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

func (RemoveTagsFromResourceOutput) GoString 

func (s RemoveTagsFromResourceOutput) 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 (RemoveTagsFromResourceOutput) String 

func (s RemoveTagsFromResourceOutput) 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 ResetDBClusterParameterGroupInput 

type ResetDBClusterParameterGroupInput struct {

	// The name of the cluster parameter group to reset.
	//
	// DBClusterParameterGroupName is a required field
	DBClusterParameterGroupName *string `type:"string" required:"true"`

	// A list of parameter names in the cluster parameter group to reset to the
	// default values. You can't use this parameter if the ResetAllParameters parameter
	// is set to true.
	Parameters []*Parameter `locationNameList:"Parameter" type:"list"`

	// A value that is set to true to reset all parameters in the cluster parameter
	// group to their default values, and false otherwise. You can't use this parameter
	// if there is a list of parameter names specified for the Parameters parameter.
	ResetAllParameters *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Represents the input to ResetDBClusterParameterGroup.

func (ResetDBClusterParameterGroupInput) GoString 

func (s ResetDBClusterParameterGroupInput) 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 (*ResetDBClusterParameterGroupInput) SetDBClusterParameterGroupName 

func (s *ResetDBClusterParameterGroupInput) SetDBClusterParameterGroupName(v string) *ResetDBClusterParameterGroupInput

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*ResetDBClusterParameterGroupInput) SetParameters 

func (s *ResetDBClusterParameterGroupInput) SetParameters(v []*Parameter) *ResetDBClusterParameterGroupInput

SetParameters sets the Parameters field's value.

func (*ResetDBClusterParameterGroupInput) SetResetAllParameters 

func (s *ResetDBClusterParameterGroupInput) SetResetAllParameters(v bool) *ResetDBClusterParameterGroupInput

SetResetAllParameters sets the ResetAllParameters field's value.

func (ResetDBClusterParameterGroupInput) String 

func (s ResetDBClusterParameterGroupInput) 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 (*ResetDBClusterParameterGroupInput) Validate 

func (s *ResetDBClusterParameterGroupInput) Validate() error

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

type ResetDBClusterParameterGroupOutput 

type ResetDBClusterParameterGroupOutput struct {

	// The name of a cluster parameter group.
	//
	// Constraints:
	//
	//    * Must be from 1 to 255 letters or numbers.
	//
	//    * The first character must be a letter.
	//
	//    * Cannot end with a hyphen or contain two consecutive hyphens.
	//
	// This value is stored as a lowercase string.
	DBClusterParameterGroupName *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the name of a cluster parameter group.

func (ResetDBClusterParameterGroupOutput) GoString 

func (s ResetDBClusterParameterGroupOutput) 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 (*ResetDBClusterParameterGroupOutput) SetDBClusterParameterGroupName 

func (s *ResetDBClusterParameterGroupOutput) SetDBClusterParameterGroupName(v string) *ResetDBClusterParameterGroupOutput

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (ResetDBClusterParameterGroupOutput) String 

func (s ResetDBClusterParameterGroupOutput) 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 ResourcePendingMaintenanceActions 

type ResourcePendingMaintenanceActions struct {

	// A list that provides details about the pending maintenance actions for the
	// resource.
	PendingMaintenanceActionDetails []*PendingMaintenanceAction `locationNameList:"PendingMaintenanceAction" type:"list"`

	// The Amazon Resource Name (ARN) of the resource that has pending maintenance
	// actions.
	ResourceIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of ApplyPendingMaintenanceAction.

func (ResourcePendingMaintenanceActions) GoString 

func (s ResourcePendingMaintenanceActions) 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 (*ResourcePendingMaintenanceActions) SetPendingMaintenanceActionDetails 

func (s *ResourcePendingMaintenanceActions) SetPendingMaintenanceActionDetails(v []*PendingMaintenanceAction) *ResourcePendingMaintenanceActions

SetPendingMaintenanceActionDetails sets the PendingMaintenanceActionDetails field's value.

func (*ResourcePendingMaintenanceActions) SetResourceIdentifier 

func (s *ResourcePendingMaintenanceActions) SetResourceIdentifier(v string) *ResourcePendingMaintenanceActions

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (ResourcePendingMaintenanceActions) String 

func (s ResourcePendingMaintenanceActions) 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 RestoreDBClusterFromSnapshotInput 

type RestoreDBClusterFromSnapshotInput struct {

	// Provides the list of Amazon EC2 Availability Zones that instances in the
	// restored DB cluster can be created in.
	AvailabilityZones []*string `locationNameList:"AvailabilityZone" type:"list"`

	// The name of the cluster to create from the snapshot or cluster snapshot.
	// This parameter isn't 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: my-snapshot-id
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The name of the DB cluster parameter group to associate with this DB cluster.
	//
	// Type: String. Required: No.
	//
	// If this argument is omitted, the default DB cluster parameter group is used.
	// If supplied, must match the name of an existing default DB cluster parameter
	// group. The string must consist of from 1 to 255 letters, numbers or hyphens.
	// Its first character must be a letter, and it cannot end with a hyphen or
	// contain two consecutive hyphens.
	DBClusterParameterGroupName *string `type:"string"`

	// The name of the subnet group to use for the new cluster.
	//
	// Constraints: If provided, must match the name of an existing DBSubnetGroup.
	//
	// Example: mySubnetgroup
	DBSubnetGroupName *string `type:"string"`

	// Specifies whether this cluster can be deleted. If DeletionProtection is enabled,
	// the cluster cannot be deleted unless it is modified and DeletionProtection
	// is disabled. DeletionProtection protects clusters from being accidentally
	// deleted.
	DeletionProtection *bool `type:"boolean"`

	// A list of log types that must be enabled for exporting to Amazon CloudWatch
	// Logs.
	EnableCloudwatchLogsExports []*string `type:"list"`

	// The database engine to use for the new cluster.
	//
	// Default: The same as source.
	//
	// Constraint: Must be compatible with the engine of the source.
	//
	// Engine is a required field
	Engine *string `type:"string" required:"true"`

	// The version of the database engine to use for the new cluster.
	EngineVersion *string `type:"string"`

	// The KMS key identifier to use when restoring an encrypted cluster from a
	// DB snapshot or cluster snapshot.
	//
	// The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption
	// key. If you are restoring a cluster with the same Amazon Web Services account
	// that owns the KMS encryption key used to encrypt the new cluster, then you
	// can use the KMS key alias instead of the ARN for the KMS encryption key.
	//
	// If you do not specify a value for the KmsKeyId parameter, then the following
	// occurs:
	//
	//    * If the snapshot or cluster snapshot in SnapshotIdentifier is encrypted,
	//    then the restored cluster is encrypted using the KMS key that was used
	//    to encrypt the snapshot or the cluster snapshot.
	//
	//    * If the snapshot or the cluster snapshot in SnapshotIdentifier is not
	//    encrypted, then the restored DB cluster is not encrypted.
	KmsKeyId *string `type:"string"`

	// The port number on which the new cluster accepts connections.
	//
	// Constraints: Must be a value from 1150 to 65535.
	//
	// Default: The same port as the original cluster.
	Port *int64 `type:"integer"`

	// The identifier for the snapshot or cluster snapshot to restore from.
	//
	// You can use either the name or the Amazon Resource Name (ARN) to specify
	// a cluster snapshot. However, you can use only the ARN to specify a snapshot.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing snapshot.
	//
	// SnapshotIdentifier is a required field
	SnapshotIdentifier *string `type:"string" required:"true"`

	// The storage type to associate with the DB cluster.
	//
	// For information on storage types for Amazon DocumentDB clusters, see Cluster
	// storage configurations in the Amazon DocumentDB Developer Guide.
	//
	// Valid values for storage type - standard | iopt1
	//
	// Default value is standard
	StorageType *string `type:"string"`

	// The tags to be assigned to the restored cluster.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// A list of virtual private cloud (VPC) security groups that the new cluster
	// will belong to.
	VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"`
	// contains filtered or unexported fields
}

Represents the input to RestoreDBClusterFromSnapshot.

func (RestoreDBClusterFromSnapshotInput) GoString 

func (s RestoreDBClusterFromSnapshotInput) 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 (*RestoreDBClusterFromSnapshotInput) SetAvailabilityZones 

func (s *RestoreDBClusterFromSnapshotInput) SetAvailabilityZones(v []*string) *RestoreDBClusterFromSnapshotInput

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*RestoreDBClusterFromSnapshotInput) SetDBClusterIdentifier 

func (s *RestoreDBClusterFromSnapshotInput) SetDBClusterIdentifier(v string) *RestoreDBClusterFromSnapshotInput

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*RestoreDBClusterFromSnapshotInput) SetDBClusterParameterGroupName added in v1.44.239 

func (s *RestoreDBClusterFromSnapshotInput) SetDBClusterParameterGroupName(v string) *RestoreDBClusterFromSnapshotInput

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*RestoreDBClusterFromSnapshotInput) SetDBSubnetGroupName 

func (s *RestoreDBClusterFromSnapshotInput) SetDBSubnetGroupName(v string) *RestoreDBClusterFromSnapshotInput

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*RestoreDBClusterFromSnapshotInput) SetDeletionProtection added in v1.20.13 

func (s *RestoreDBClusterFromSnapshotInput) SetDeletionProtection(v bool) *RestoreDBClusterFromSnapshotInput

SetDeletionProtection sets the DeletionProtection field's value.

func (*RestoreDBClusterFromSnapshotInput) SetEnableCloudwatchLogsExports 

func (s *RestoreDBClusterFromSnapshotInput) SetEnableCloudwatchLogsExports(v []*string) *RestoreDBClusterFromSnapshotInput

SetEnableCloudwatchLogsExports sets the EnableCloudwatchLogsExports field's value.

func (*RestoreDBClusterFromSnapshotInput) SetEngine 

func (s *RestoreDBClusterFromSnapshotInput) SetEngine(v string) *RestoreDBClusterFromSnapshotInput

SetEngine sets the Engine field's value.

func (*RestoreDBClusterFromSnapshotInput) SetEngineVersion 

func (s *RestoreDBClusterFromSnapshotInput) SetEngineVersion(v string) *RestoreDBClusterFromSnapshotInput

SetEngineVersion sets the EngineVersion field's value.

func (*RestoreDBClusterFromSnapshotInput) SetKmsKeyId 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*RestoreDBClusterFromSnapshotInput) SetPort 

func (s *RestoreDBClusterFromSnapshotInput) SetPort(v int64) *RestoreDBClusterFromSnapshotInput

SetPort sets the Port field's value.

func (*RestoreDBClusterFromSnapshotInput) SetSnapshotIdentifier 

func (s *RestoreDBClusterFromSnapshotInput) SetSnapshotIdentifier(v string) *RestoreDBClusterFromSnapshotInput

SetSnapshotIdentifier sets the SnapshotIdentifier field's value.

func (*RestoreDBClusterFromSnapshotInput) SetStorageType added in v1.48.1 

func (s *RestoreDBClusterFromSnapshotInput) SetStorageType(v string) *RestoreDBClusterFromSnapshotInput

SetStorageType sets the StorageType field's value.

func (*RestoreDBClusterFromSnapshotInput) SetTags 

func (s *RestoreDBClusterFromSnapshotInput) SetTags(v []*Tag) *RestoreDBClusterFromSnapshotInput

SetTags sets the Tags field's value.

func (*RestoreDBClusterFromSnapshotInput) SetVpcSecurityGroupIds 

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

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (RestoreDBClusterFromSnapshotInput) String 

func (s RestoreDBClusterFromSnapshotInput) 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 (*RestoreDBClusterFromSnapshotInput) Validate 

func (s *RestoreDBClusterFromSnapshotInput) Validate() error

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

type RestoreDBClusterFromSnapshotOutput 

type RestoreDBClusterFromSnapshotOutput struct {

	// Detailed information about a cluster.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (RestoreDBClusterFromSnapshotOutput) GoString 

func (s RestoreDBClusterFromSnapshotOutput) 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 (*RestoreDBClusterFromSnapshotOutput) SetDBCluster 

func (s *RestoreDBClusterFromSnapshotOutput) SetDBCluster(v *DBCluster) *RestoreDBClusterFromSnapshotOutput

SetDBCluster sets the DBCluster field's value.

func (RestoreDBClusterFromSnapshotOutput) String 

func (s RestoreDBClusterFromSnapshotOutput) 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 RestoreDBClusterToPointInTimeInput 

type RestoreDBClusterToPointInTimeInput struct {

	// The name of the new cluster to be created.
	//
	// 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.
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The subnet group name to use for the new cluster.
	//
	// Constraints: If provided, must match the name of an existing DBSubnetGroup.
	//
	// Example: mySubnetgroup
	DBSubnetGroupName *string `type:"string"`

	// Specifies whether this cluster can be deleted. If DeletionProtection is enabled,
	// the cluster cannot be deleted unless it is modified and DeletionProtection
	// is disabled. DeletionProtection protects clusters from being accidentally
	// deleted.
	DeletionProtection *bool `type:"boolean"`

	// A list of log types that must be enabled for exporting to Amazon CloudWatch
	// Logs.
	EnableCloudwatchLogsExports []*string `type:"list"`

	// The KMS key identifier to use when restoring an encrypted cluster from an
	// encrypted cluster.
	//
	// The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption
	// key. If you are restoring a cluster with the same Amazon Web Services account
	// that owns the KMS encryption key used to encrypt the new cluster, then you
	// can use the KMS key alias instead of the ARN for the KMS encryption key.
	//
	// You can restore to a new cluster and encrypt the new cluster with an KMS
	// key that is different from the KMS key used to encrypt the source cluster.
	// The new DB cluster is encrypted with the KMS key identified by the KmsKeyId
	// parameter.
	//
	// If you do not specify a value for the KmsKeyId parameter, then the following
	// occurs:
	//
	//    * If the cluster is encrypted, then the restored cluster is encrypted
	//    using the KMS key that was used to encrypt the source cluster.
	//
	//    * If the cluster is not encrypted, then the restored cluster is not encrypted.
	//
	// If DBClusterIdentifier refers to a cluster that is not encrypted, then the
	// restore request is rejected.
	KmsKeyId *string `type:"string"`

	// The port number on which the new cluster accepts connections.
	//
	// Constraints: Must be a value from 1150 to 65535.
	//
	// Default: The default port for the engine.
	Port *int64 `type:"integer"`

	// The date and time to restore the cluster to.
	//
	// Valid values: A time in Universal Coordinated Time (UTC) format.
	//
	// Constraints:
	//
	//    * Must be before the latest restorable time for the instance.
	//
	//    * Must be specified if the UseLatestRestorableTime parameter is not provided.
	//
	//    * Cannot be specified if the UseLatestRestorableTime parameter is true.
	//
	//    * Cannot be specified if the RestoreType parameter is copy-on-write.
	//
	// Example: 2015-03-07T23:45:00Z
	RestoreToTime *time.Time `type:"timestamp"`

	// The type of restore to be performed. You can specify one of the following
	// values:
	//
	//    * full-copy - The new DB cluster is restored as a full copy of the source
	//    DB cluster.
	//
	//    * copy-on-write - The new DB cluster is restored as a clone of the source
	//    DB cluster.
	//
	// Constraints: You can't specify copy-on-write if the engine version of the
	// source DB cluster is earlier than 1.11.
	//
	// If you don't specify a RestoreType value, then the new DB cluster is restored
	// as a full copy of the source DB cluster.
	RestoreType *string `type:"string"`

	// The identifier of the source cluster from which to restore.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBCluster.
	//
	// SourceDBClusterIdentifier is a required field
	SourceDBClusterIdentifier *string `type:"string" required:"true"`

	// The storage type to associate with the DB cluster.
	//
	// For information on storage types for Amazon DocumentDB clusters, see Cluster
	// storage configurations in the Amazon DocumentDB Developer Guide.
	//
	// Valid values for storage type - standard | iopt1
	//
	// Default value is standard
	StorageType *string `type:"string"`

	// The tags to be assigned to the restored cluster.
	Tags []*Tag `locationNameList:"Tag" type:"list"`

	// A value that is set to true to restore the cluster to the latest restorable
	// backup time, and false otherwise.
	//
	// Default: false
	//
	// Constraints: Cannot be specified if the RestoreToTime parameter is provided.
	UseLatestRestorableTime *bool `type:"boolean"`

	// A list of VPC security groups that the new cluster belongs to.
	VpcSecurityGroupIds []*string `locationNameList:"VpcSecurityGroupId" type:"list"`
	// contains filtered or unexported fields
}

Represents the input to RestoreDBClusterToPointInTime.

func (RestoreDBClusterToPointInTimeInput) GoString 

func (s RestoreDBClusterToPointInTimeInput) 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 (*RestoreDBClusterToPointInTimeInput) SetDBClusterIdentifier 

func (s *RestoreDBClusterToPointInTimeInput) SetDBClusterIdentifier(v string) *RestoreDBClusterToPointInTimeInput

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*RestoreDBClusterToPointInTimeInput) SetDBSubnetGroupName 

func (s *RestoreDBClusterToPointInTimeInput) SetDBSubnetGroupName(v string) *RestoreDBClusterToPointInTimeInput

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*RestoreDBClusterToPointInTimeInput) SetDeletionProtection added in v1.20.13 

func (s *RestoreDBClusterToPointInTimeInput) SetDeletionProtection(v bool) *RestoreDBClusterToPointInTimeInput

SetDeletionProtection sets the DeletionProtection field's value.

func (*RestoreDBClusterToPointInTimeInput) SetEnableCloudwatchLogsExports 

func (s *RestoreDBClusterToPointInTimeInput) SetEnableCloudwatchLogsExports(v []*string) *RestoreDBClusterToPointInTimeInput

SetEnableCloudwatchLogsExports sets the EnableCloudwatchLogsExports field's value.

func (*RestoreDBClusterToPointInTimeInput) SetKmsKeyId 

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*RestoreDBClusterToPointInTimeInput) SetPort 

func (s *RestoreDBClusterToPointInTimeInput) SetPort(v int64) *RestoreDBClusterToPointInTimeInput

SetPort sets the Port field's value.

func (*RestoreDBClusterToPointInTimeInput) SetRestoreToTime 

func (s *RestoreDBClusterToPointInTimeInput) SetRestoreToTime(v time.Time) *RestoreDBClusterToPointInTimeInput

SetRestoreToTime sets the RestoreToTime field's value.

func (*RestoreDBClusterToPointInTimeInput) SetRestoreType added in v1.44.60 

func (s *RestoreDBClusterToPointInTimeInput) SetRestoreType(v string) *RestoreDBClusterToPointInTimeInput

SetRestoreType sets the RestoreType field's value.

func (*RestoreDBClusterToPointInTimeInput) SetSourceDBClusterIdentifier 

func (s *RestoreDBClusterToPointInTimeInput) SetSourceDBClusterIdentifier(v string) *RestoreDBClusterToPointInTimeInput

SetSourceDBClusterIdentifier sets the SourceDBClusterIdentifier field's value.

func (*RestoreDBClusterToPointInTimeInput) SetStorageType added in v1.48.1 

func (s *RestoreDBClusterToPointInTimeInput) SetStorageType(v string) *RestoreDBClusterToPointInTimeInput

SetStorageType sets the StorageType field's value.

func (*RestoreDBClusterToPointInTimeInput) SetTags 

func (s *RestoreDBClusterToPointInTimeInput) SetTags(v []*Tag) *RestoreDBClusterToPointInTimeInput

SetTags sets the Tags field's value.

func (*RestoreDBClusterToPointInTimeInput) SetUseLatestRestorableTime 

func (s *RestoreDBClusterToPointInTimeInput) SetUseLatestRestorableTime(v bool) *RestoreDBClusterToPointInTimeInput

SetUseLatestRestorableTime sets the UseLatestRestorableTime field's value.

func (*RestoreDBClusterToPointInTimeInput) SetVpcSecurityGroupIds 

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

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (RestoreDBClusterToPointInTimeInput) String 

func (s RestoreDBClusterToPointInTimeInput) 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 (*RestoreDBClusterToPointInTimeInput) Validate 

func (s *RestoreDBClusterToPointInTimeInput) Validate() error

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

type RestoreDBClusterToPointInTimeOutput 

type RestoreDBClusterToPointInTimeOutput struct {

	// Detailed information about a cluster.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (RestoreDBClusterToPointInTimeOutput) GoString 

func (s RestoreDBClusterToPointInTimeOutput) 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 (*RestoreDBClusterToPointInTimeOutput) SetDBCluster 

func (s *RestoreDBClusterToPointInTimeOutput) SetDBCluster(v *DBCluster) *RestoreDBClusterToPointInTimeOutput

SetDBCluster sets the DBCluster field's value.

func (RestoreDBClusterToPointInTimeOutput) String 

func (s RestoreDBClusterToPointInTimeOutput) 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 StartDBClusterInput added in v1.20.13 

type StartDBClusterInput struct {

	// The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartDBClusterInput) GoString added in v1.20.13 

func (s StartDBClusterInput) 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 (*StartDBClusterInput) SetDBClusterIdentifier added in v1.20.13 

func (s *StartDBClusterInput) SetDBClusterIdentifier(v string) *StartDBClusterInput

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (StartDBClusterInput) String added in v1.20.13 

func (s StartDBClusterInput) 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 (*StartDBClusterInput) Validate added in v1.20.13 

func (s *StartDBClusterInput) Validate() error

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

type StartDBClusterOutput added in v1.20.13 

type StartDBClusterOutput struct {

	// Detailed information about a cluster.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (StartDBClusterOutput) GoString added in v1.20.13 

func (s StartDBClusterOutput) 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 (*StartDBClusterOutput) SetDBCluster added in v1.20.13 

func (s *StartDBClusterOutput) SetDBCluster(v *DBCluster) *StartDBClusterOutput

SetDBCluster sets the DBCluster field's value.

func (StartDBClusterOutput) String added in v1.20.13 

func (s StartDBClusterOutput) 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 StopDBClusterInput added in v1.20.13 

type StopDBClusterInput struct {

	// The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopDBClusterInput) GoString added in v1.20.13 

func (s StopDBClusterInput) 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 (*StopDBClusterInput) SetDBClusterIdentifier added in v1.20.13 

func (s *StopDBClusterInput) SetDBClusterIdentifier(v string) *StopDBClusterInput

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (StopDBClusterInput) String added in v1.20.13 

func (s StopDBClusterInput) 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 (*StopDBClusterInput) Validate added in v1.20.13 

func (s *StopDBClusterInput) Validate() error

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

type StopDBClusterOutput added in v1.20.13 

type StopDBClusterOutput struct {

	// Detailed information about a cluster.
	DBCluster *DBCluster `type:"structure"`
	// contains filtered or unexported fields
}

func (StopDBClusterOutput) GoString added in v1.20.13 

func (s StopDBClusterOutput) 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 (*StopDBClusterOutput) SetDBCluster added in v1.20.13 

func (s *StopDBClusterOutput) SetDBCluster(v *DBCluster) *StopDBClusterOutput

SetDBCluster sets the DBCluster field's value.

func (StopDBClusterOutput) String added in v1.20.13 

func (s StopDBClusterOutput) 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 Subnet 

type Subnet struct {

	// Specifies the Availability Zone for the subnet.
	SubnetAvailabilityZone *AvailabilityZone `type:"structure"`

	// Specifies the identifier of the subnet.
	SubnetIdentifier *string `type:"string"`

	// Specifies the status of the subnet.
	SubnetStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Detailed information about a subnet.

func (Subnet) GoString 

func (s Subnet) 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 (*Subnet) SetSubnetAvailabilityZone 

func (s *Subnet) SetSubnetAvailabilityZone(v *AvailabilityZone) *Subnet

SetSubnetAvailabilityZone sets the SubnetAvailabilityZone field's value.

func (*Subnet) SetSubnetIdentifier 

func (s *Subnet) SetSubnetIdentifier(v string) *Subnet

SetSubnetIdentifier sets the SubnetIdentifier field's value.

func (*Subnet) SetSubnetStatus 

func (s *Subnet) SetSubnetStatus(v string) *Subnet

SetSubnetStatus sets the SubnetStatus field's value.

func (Subnet) String 

func (s Subnet) 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 Tag 

type Tag struct {

	// The required name of the tag. The string value can be from 1 to 128 Unicode
	// characters in length and can't be prefixed with "aws:" or "rds:". The string
	// can contain only the set of Unicode letters, digits, white space, '_', '.',
	// '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
	Key *string `type:"string"`

	// The optional value of the tag. The string value can be from 1 to 256 Unicode
	// characters in length and can't be prefixed with "aws:" or "rds:". The string
	// can contain only the set of Unicode letters, digits, white space, '_', '.',
	// '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.

func (Tag) GoString 

func (s Tag) 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 (*Tag) SetKey 

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue 

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String 

func (s Tag) 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 UpgradeTarget 

type UpgradeTarget struct {

	// A value that indicates whether the target version is applied to any source
	// DB instances that have AutoMinorVersionUpgrade set to true.
	AutoUpgrade *bool `type:"boolean"`

	// The version of the database engine that an instance can be upgraded to.
	Description *string `type:"string"`

	// The name of the upgrade target database engine.
	Engine *string `type:"string"`

	// The version number of the upgrade target database engine.
	EngineVersion *string `type:"string"`

	// A value that indicates whether a database engine is upgraded to a major version.
	IsMajorVersionUpgrade *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The version of the database engine that an instance can be upgraded to.

func (UpgradeTarget) GoString 

func (s UpgradeTarget) 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 (*UpgradeTarget) SetAutoUpgrade 

func (s *UpgradeTarget) SetAutoUpgrade(v bool) *UpgradeTarget

SetAutoUpgrade sets the AutoUpgrade field's value.

func (*UpgradeTarget) SetDescription 

func (s *UpgradeTarget) SetDescription(v string) *UpgradeTarget

SetDescription sets the Description field's value.

func (*UpgradeTarget) SetEngine 

func (s *UpgradeTarget) SetEngine(v string) *UpgradeTarget

SetEngine sets the Engine field's value.

func (*UpgradeTarget) SetEngineVersion 

func (s *UpgradeTarget) SetEngineVersion(v string) *UpgradeTarget

SetEngineVersion sets the EngineVersion field's value.

func (*UpgradeTarget) SetIsMajorVersionUpgrade 

func (s *UpgradeTarget) SetIsMajorVersionUpgrade(v bool) *UpgradeTarget

SetIsMajorVersionUpgrade sets the IsMajorVersionUpgrade field's value.

func (UpgradeTarget) String 

func (s UpgradeTarget) 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 VpcSecurityGroupMembership 

type VpcSecurityGroupMembership struct {

	// The status of the VPC security group.
	Status *string `type:"string"`

	// The name of the VPC security group.
	VpcSecurityGroupId *string `type:"string"`
	// contains filtered or unexported fields
}

Used as a response element for queries on virtual private cloud (VPC) security group membership.

func (VpcSecurityGroupMembership) GoString 

func (s VpcSecurityGroupMembership) 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 (*VpcSecurityGroupMembership) SetStatus 

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

SetStatus sets the Status field's value.

func (*VpcSecurityGroupMembership) SetVpcSecurityGroupId 

func (s *VpcSecurityGroupMembership) SetVpcSecurityGroupId(v string) *VpcSecurityGroupMembership

SetVpcSecurityGroupId sets the VpcSecurityGroupId field's value.

func (VpcSecurityGroupMembership) String 

func (s VpcSecurityGroupMembership) 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 docdbiface provides an interface to enable mocking the Amazon DocumentDB with MongoDB compatibility service client for testing your code.
 Package docdbiface provides an interface to enable mocking the Amazon DocumentDB with MongoDB compatibility 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.