aws-sdk-go: github.com/aws/aws-sdk-go/service/docdb Index | Files | Directories

package docdb

import "github.com/aws/aws-sdk-go/service/docdb"

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

Amazon DocumentDB API documentation

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

Package Files

api.go doc.go errors.go service.go waiters.go

Constants

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

    // ApplyMethodPendingReboot is a ApplyMethod enum value
    ApplyMethodPendingReboot = "pending-reboot"
)
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"
)
const (

    // ErrCodeAuthorizationNotFoundFault for service response error code
    // "AuthorizationNotFound".
    //
    // The specified CIDR IP or Amazon EC2 security group isn't authorized for the
    // specified DB 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 DB cluster with the given identifier.
    ErrCodeDBClusterAlreadyExistsFault = "DBClusterAlreadyExistsFault"

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

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

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

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

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

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

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

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

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

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

    // ErrCodeDBSecurityGroupNotFoundFault for service response error code
    // "DBSecurityGroupNotFound".
    //
    // DBSecurityGroupName doesn't refer to an existing DB 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 DB snapshot.
    ErrCodeDBSnapshotNotFoundFault = "DBSnapshotNotFound"

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

    // ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs for service response error code
    // "DBSubnetGroupDoesNotCoverEnoughAZs".
    //
    // Subnets in the DB 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 DB subnet group.
    ErrCodeDBSubnetGroupNotFoundFault = "DBSubnetGroupNotFoundFault"

    // ErrCodeDBSubnetGroupQuotaExceededFault for service response error code
    // "DBSubnetGroupQuotaExceeded".
    //
    // The request would cause you to exceed the allowed number of DB 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
    // DB subnet group.
    ErrCodeDBSubnetQuotaExceededFault = "DBSubnetQuotaExceededFault"

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

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

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

    // ErrCodeInsufficientDBInstanceCapacityFault for service response error code
    // "InsufficientDBInstanceCapacity".
    //
    // The specified DB 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 DB cluster snapshot state.
    ErrCodeInvalidDBClusterSnapshotStateFault = "InvalidDBClusterSnapshotStateFault"

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

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

    // ErrCodeInvalidDBParameterGroupStateFault for service response error code
    // "InvalidDBParameterGroupState".
    //
    // The DB 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 DB security group doesn't allow deletion.
    ErrCodeInvalidDBSecurityGroupStateFault = "InvalidDBSecurityGroupState"

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

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

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

    // 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 DB 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 AWS KMS key.
    ErrCodeKMSKeyNotAccessibleFault = "KMSKeyNotAccessibleFault"

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

    // 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 DB snapshots.
    ErrCodeSnapshotQuotaExceededFault = "SnapshotQuotaExceeded"

    // ErrCodeStorageQuotaExceededFault for service response error code
    // "StorageQuotaExceeded".
    //
    // The request would cause you to exceed the allowed amount of storage available
    // across all DB 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 DB subnet is already in use in the Availability Zone.
    ErrCodeSubnetAlreadyInUse = "SubnetAlreadyInUse"
)
const (
    ServiceName = "DocDB" // Name of service.
    EndpointsID = "rds"   // ID to lookup a service endpoint with.
    ServiceID   = "DocDB" // ServiceID is a unique identifer of a specific service.
)

Service information constants

type AddTagsToResourceInput Uses

type AddTagsToResourceInput struct {

    // The Amazon DocumentDB resource that the tags are added to. This value is
    // an Amazon Resource Name (ARN).
    //
    // 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 Uses

func (s AddTagsToResourceInput) GoString() string

GoString returns the string representation

func (*AddTagsToResourceInput) SetResourceName Uses

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

SetResourceName sets the ResourceName field's value.

func (*AddTagsToResourceInput) SetTags Uses

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

SetTags sets the Tags field's value.

func (AddTagsToResourceInput) String Uses

func (s AddTagsToResourceInput) String() string

String returns the string representation

func (*AddTagsToResourceInput) Validate Uses

func (s *AddTagsToResourceInput) Validate() error

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

type AddTagsToResourceOutput Uses

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

func (AddTagsToResourceOutput) GoString Uses

func (s AddTagsToResourceOutput) GoString() string

GoString returns the string representation

func (AddTagsToResourceOutput) String Uses

func (s AddTagsToResourceOutput) String() string

String returns the string representation

type ApplyPendingMaintenanceActionInput Uses

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 Uses

func (s ApplyPendingMaintenanceActionInput) GoString() string

GoString returns the string representation

func (*ApplyPendingMaintenanceActionInput) SetApplyAction Uses

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

SetApplyAction sets the ApplyAction field's value.

func (*ApplyPendingMaintenanceActionInput) SetOptInType Uses

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

SetOptInType sets the OptInType field's value.

func (*ApplyPendingMaintenanceActionInput) SetResourceIdentifier Uses

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

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (ApplyPendingMaintenanceActionInput) String Uses

func (s ApplyPendingMaintenanceActionInput) String() string

String returns the string representation

func (*ApplyPendingMaintenanceActionInput) Validate Uses

func (s *ApplyPendingMaintenanceActionInput) Validate() error

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

type ApplyPendingMaintenanceActionOutput Uses

type ApplyPendingMaintenanceActionOutput struct {

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

func (ApplyPendingMaintenanceActionOutput) GoString Uses

func (s ApplyPendingMaintenanceActionOutput) GoString() string

GoString returns the string representation

func (*ApplyPendingMaintenanceActionOutput) SetResourcePendingMaintenanceActions Uses

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

SetResourcePendingMaintenanceActions sets the ResourcePendingMaintenanceActions field's value.

func (ApplyPendingMaintenanceActionOutput) String Uses

func (s ApplyPendingMaintenanceActionOutput) String() string

String returns the string representation

type AvailabilityZone Uses

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 Uses

func (s AvailabilityZone) GoString() string

GoString returns the string representation

func (*AvailabilityZone) SetName Uses

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

SetName sets the Name field's value.

func (AvailabilityZone) String Uses

func (s AvailabilityZone) String() string

String returns the string representation

type CloudwatchLogsExportConfiguration Uses

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 DB instance or DB 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 DB engine that is being used.

func (CloudwatchLogsExportConfiguration) GoString Uses

func (s CloudwatchLogsExportConfiguration) GoString() string

GoString returns the string representation

func (*CloudwatchLogsExportConfiguration) SetDisableLogTypes Uses

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

SetDisableLogTypes sets the DisableLogTypes field's value.

func (*CloudwatchLogsExportConfiguration) SetEnableLogTypes Uses

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

SetEnableLogTypes sets the EnableLogTypes field's value.

func (CloudwatchLogsExportConfiguration) String Uses

func (s CloudwatchLogsExportConfiguration) String() string

String returns the string representation

type CopyDBClusterParameterGroupInput Uses

type CopyDBClusterParameterGroupInput struct {

    // The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter
    // group.
    //
    // Constraints:
    //
    //    * Must specify a valid DB cluster parameter group.
    //
    //    * If the source DB cluster parameter group is in the same AWS Region as
    //    the copy, specify a valid DB parameter group identifier; for example,
    //    my-db-cluster-param-group, or a valid ARN.
    //
    //    * If the source DB parameter group is in a different AWS Region than the
    //    copy, specify a valid DB cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.
    //
    // 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 DB cluster parameter group.
    //
    // TargetDBClusterParameterGroupDescription is a required field
    TargetDBClusterParameterGroupDescription *string `type:"string" required:"true"`

    // The identifier for the copied DB 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 Uses

func (s CopyDBClusterParameterGroupInput) GoString() string

GoString returns the string representation

func (*CopyDBClusterParameterGroupInput) SetSourceDBClusterParameterGroupIdentifier Uses

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

SetSourceDBClusterParameterGroupIdentifier sets the SourceDBClusterParameterGroupIdentifier field's value.

func (*CopyDBClusterParameterGroupInput) SetTags Uses

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

SetTags sets the Tags field's value.

func (*CopyDBClusterParameterGroupInput) SetTargetDBClusterParameterGroupDescription Uses

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

SetTargetDBClusterParameterGroupDescription sets the TargetDBClusterParameterGroupDescription field's value.

func (*CopyDBClusterParameterGroupInput) SetTargetDBClusterParameterGroupIdentifier Uses

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

SetTargetDBClusterParameterGroupIdentifier sets the TargetDBClusterParameterGroupIdentifier field's value.

func (CopyDBClusterParameterGroupInput) String Uses

func (s CopyDBClusterParameterGroupInput) String() string

String returns the string representation

func (*CopyDBClusterParameterGroupInput) Validate Uses

func (s *CopyDBClusterParameterGroupInput) Validate() error

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

type CopyDBClusterParameterGroupOutput Uses

type CopyDBClusterParameterGroupOutput struct {

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

func (CopyDBClusterParameterGroupOutput) GoString Uses

func (s CopyDBClusterParameterGroupOutput) GoString() string

GoString returns the string representation

func (*CopyDBClusterParameterGroupOutput) SetDBClusterParameterGroup Uses

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

SetDBClusterParameterGroup sets the DBClusterParameterGroup field's value.

func (CopyDBClusterParameterGroupOutput) String Uses

func (s CopyDBClusterParameterGroupOutput) String() string

String returns the string representation

type CopyDBClusterSnapshotInput Uses

type CopyDBClusterSnapshotInput struct {

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

    // The AWS KMS key ID for an encrypted DB cluster snapshot. The AWS KMS key
    // ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS
    // KMS key alias for the AWS KMS encryption key.
    //
    // If you copy an encrypted DB cluster snapshot from your AWS account, you can
    // specify a value for KmsKeyId to encrypt the copy with a new AWS KMS encryption
    // key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster
    // snapshot is encrypted with the same AWS KMS key as the source DB cluster
    // snapshot.
    //
    // If you copy an encrypted DB cluster snapshot that is shared from another
    // AWS account, then you must specify a value for KmsKeyId.
    //
    // To copy an encrypted DB cluster snapshot to another AWS Region, set KmsKeyId
    // to the AWS KMS key ID that you want to use to encrypt the copy of the DB
    // cluster snapshot in the destination Region. AWS KMS encryption keys are specific
    // to the AWS Region that they are created in, and you can't use encryption
    // keys from one Region in another Region.
    //
    // If you copy an unencrypted DB 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 the CopyDBClusterSnapshot
    // API action in the AWS Region that contains the source DB cluster snapshot
    // to copy. You must use the PreSignedUrl parameter when copying an encrypted
    // DB cluster snapshot from another AWS Region.
    //
    // The presigned URL must be a valid request for the CopyDBSClusterSnapshot
    // API action that can be executed in the source AWS Region that contains the
    // encrypted DB cluster snapshot to be copied. The presigned URL request must
    // contain the following parameter values:
    //
    //    * KmsKeyId - The AWS KMS key identifier for the key to use to encrypt
    //    the copy of the DB cluster snapshot in the destination AWS Region. This
    //    is the same identifier for both the CopyDBClusterSnapshot action that
    //    is called in the destination AWS Region, and the action contained in the
    //    presigned URL.
    //
    //    * DestinationRegion - The name of the AWS Region that the DB cluster snapshot
    //    will be created in.
    //
    //    * SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier
    //    for the encrypted DB cluster snapshot to be copied. This identifier must
    //    be in the Amazon Resource Name (ARN) format for the source AWS Region.
    //    For example, if you are copying an encrypted DB cluster snapshot from
    //    the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier
    //    looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115.
    PreSignedUrl *string `type:"string"`

    // The identifier of the DB cluster snapshot to copy. This parameter is not
    // case sensitive.
    //
    // You can't copy an encrypted, shared DB cluster snapshot from one AWS Region
    // to another.
    //
    // Constraints:
    //
    //    * Must specify a valid system snapshot in the "available" state.
    //
    //    * If the source snapshot is in the same AWS Region as the copy, specify
    //    a valid DB snapshot identifier.
    //
    //    * If the source snapshot is in a different AWS Region than the copy, specify
    //    a valid DB cluster snapshot ARN.
    //
    // Example: my-cluster-snapshot1
    //
    // SourceDBClusterSnapshotIdentifier is a required field
    SourceDBClusterSnapshotIdentifier *string `type:"string" required:"true"`

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

    // The identifier of the new DB cluster snapshot to create from the source DB
    // 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 Uses

func (s CopyDBClusterSnapshotInput) GoString() string

GoString returns the string representation

func (*CopyDBClusterSnapshotInput) SetCopyTags Uses

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

SetCopyTags sets the CopyTags field's value.

func (*CopyDBClusterSnapshotInput) SetKmsKeyId Uses

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*CopyDBClusterSnapshotInput) SetPreSignedUrl Uses

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

SetPreSignedUrl sets the PreSignedUrl field's value.

func (*CopyDBClusterSnapshotInput) SetSourceDBClusterSnapshotIdentifier Uses

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

SetSourceDBClusterSnapshotIdentifier sets the SourceDBClusterSnapshotIdentifier field's value.

func (*CopyDBClusterSnapshotInput) SetTags Uses

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

SetTags sets the Tags field's value.

func (*CopyDBClusterSnapshotInput) SetTargetDBClusterSnapshotIdentifier Uses

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

SetTargetDBClusterSnapshotIdentifier sets the TargetDBClusterSnapshotIdentifier field's value.

func (CopyDBClusterSnapshotInput) String Uses

func (s CopyDBClusterSnapshotInput) String() string

String returns the string representation

func (*CopyDBClusterSnapshotInput) Validate Uses

func (s *CopyDBClusterSnapshotInput) Validate() error

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

type CopyDBClusterSnapshotOutput Uses

type CopyDBClusterSnapshotOutput struct {

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

func (CopyDBClusterSnapshotOutput) GoString Uses

func (s CopyDBClusterSnapshotOutput) GoString() string

GoString returns the string representation

func (*CopyDBClusterSnapshotOutput) SetDBClusterSnapshot Uses

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

SetDBClusterSnapshot sets the DBClusterSnapshot field's value.

func (CopyDBClusterSnapshotOutput) String Uses

func (s CopyDBClusterSnapshotOutput) String() string

String returns the string representation

type CreateDBClusterInput Uses

type CreateDBClusterInput struct {

    // A list of Amazon EC2 Availability Zones that instances in the DB 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 DB 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 DB cluster parameter group to associate with this DB cluster.
    DBClusterParameterGroupName *string `type:"string"`

    // A DB subnet group to associate with this DB 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"`

    // A list of log types that need to be enabled for exporting to Amazon CloudWatch
    // Logs.
    EnableCloudwatchLogsExports []*string `type:"list"`

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

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

    // The AWS KMS key identifier for an encrypted DB cluster.
    //
    // The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS
    // KMS encryption key. If you are creating a DB cluster using the same AWS account
    // that owns the AWS KMS encryption key that is used to encrypt the new DB cluster,
    // you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption
    // key.
    //
    // If an encryption key is not specified in KmsKeyId:
    //
    //    * If ReplicationSourceIdentifier identifies an encrypted source, then
    //    Amazon DocumentDB uses the encryption key that is used to encrypt the
    //    source. Otherwise, Amazon DocumentDB uses your default encryption key.
    //
    //    * If the StorageEncrypted parameter is true and ReplicationSourceIdentifier
    //    is not specified, Amazon DocumentDB uses your default encryption key.
    //
    // AWS KMS creates the default encryption key for your AWS account. Your AWS
    // account has a different default encryption key for each AWS Region.
    //
    // If you create a replica of an encrypted DB cluster in another AWS Region,
    // you must set KmsKeyId to a KMS key ID that is valid in the destination AWS
    // Region. This key is used to encrypt the replica in that AWS Region.
    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 41 characters.
    //
    // MasterUserPassword is a required field
    MasterUserPassword *string `type:"string" required:"true"`

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

    // The port number on which the instances in the DB cluster accept connections.
    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 AWS 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 AWS 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"`

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

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

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

Represents the input to CreateDBCluster.

func (CreateDBClusterInput) GoString Uses

func (s CreateDBClusterInput) GoString() string

GoString returns the string representation

func (*CreateDBClusterInput) SetAvailabilityZones Uses

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

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*CreateDBClusterInput) SetBackupRetentionPeriod Uses

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*CreateDBClusterInput) SetDBClusterIdentifier Uses

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*CreateDBClusterInput) SetDBClusterParameterGroupName Uses

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

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*CreateDBClusterInput) SetDBSubnetGroupName Uses

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

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*CreateDBClusterInput) SetDeletionProtection Uses

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

SetDeletionProtection sets the DeletionProtection field's value.

func (*CreateDBClusterInput) SetEnableCloudwatchLogsExports Uses

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

SetEnableCloudwatchLogsExports sets the EnableCloudwatchLogsExports field's value.

func (*CreateDBClusterInput) SetEngine Uses

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

SetEngine sets the Engine field's value.

func (*CreateDBClusterInput) SetEngineVersion Uses

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

SetEngineVersion sets the EngineVersion field's value.

func (*CreateDBClusterInput) SetKmsKeyId Uses

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*CreateDBClusterInput) SetMasterUserPassword Uses

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

SetMasterUserPassword sets the MasterUserPassword field's value.

func (*CreateDBClusterInput) SetMasterUsername Uses

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

SetMasterUsername sets the MasterUsername field's value.

func (*CreateDBClusterInput) SetPort Uses

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

SetPort sets the Port field's value.

func (*CreateDBClusterInput) SetPreferredBackupWindow Uses

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*CreateDBClusterInput) SetPreferredMaintenanceWindow Uses

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*CreateDBClusterInput) SetStorageEncrypted Uses

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

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*CreateDBClusterInput) SetTags Uses

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

SetTags sets the Tags field's value.

func (*CreateDBClusterInput) SetVpcSecurityGroupIds Uses

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

SetVpcSecurityGroupIds sets the VpcSecurityGroupIds field's value.

func (CreateDBClusterInput) String Uses

func (s CreateDBClusterInput) String() string

String returns the string representation

func (*CreateDBClusterInput) Validate Uses

func (s *CreateDBClusterInput) Validate() error

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

type CreateDBClusterOutput Uses

type CreateDBClusterOutput struct {

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

func (CreateDBClusterOutput) GoString Uses

func (s CreateDBClusterOutput) GoString() string

GoString returns the string representation

func (*CreateDBClusterOutput) SetDBCluster Uses

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

SetDBCluster sets the DBCluster field's value.

func (CreateDBClusterOutput) String Uses

func (s CreateDBClusterOutput) String() string

String returns the string representation

type CreateDBClusterParameterGroupInput Uses

type CreateDBClusterParameterGroupInput struct {

    // The name of the DB cluster parameter group.
    //
    // Constraints:
    //
    //    * Must 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 DB cluster parameter group family name.
    //
    // DBParameterGroupFamily is a required field
    DBParameterGroupFamily *string `type:"string" required:"true"`

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

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

Represents the input of CreateDBClusterParameterGroup.

func (CreateDBClusterParameterGroupInput) GoString Uses

func (s CreateDBClusterParameterGroupInput) GoString() string

GoString returns the string representation

func (*CreateDBClusterParameterGroupInput) SetDBClusterParameterGroupName Uses

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

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*CreateDBClusterParameterGroupInput) SetDBParameterGroupFamily Uses

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

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*CreateDBClusterParameterGroupInput) SetDescription Uses

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

SetDescription sets the Description field's value.

func (*CreateDBClusterParameterGroupInput) SetTags Uses

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

SetTags sets the Tags field's value.

func (CreateDBClusterParameterGroupInput) String Uses

func (s CreateDBClusterParameterGroupInput) String() string

String returns the string representation

func (*CreateDBClusterParameterGroupInput) Validate Uses

func (s *CreateDBClusterParameterGroupInput) Validate() error

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

type CreateDBClusterParameterGroupOutput Uses

type CreateDBClusterParameterGroupOutput struct {

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

func (CreateDBClusterParameterGroupOutput) GoString Uses

func (s CreateDBClusterParameterGroupOutput) GoString() string

GoString returns the string representation

func (*CreateDBClusterParameterGroupOutput) SetDBClusterParameterGroup Uses

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

SetDBClusterParameterGroup sets the DBClusterParameterGroup field's value.

func (CreateDBClusterParameterGroupOutput) String Uses

func (s CreateDBClusterParameterGroupOutput) String() string

String returns the string representation

type CreateDBClusterSnapshotInput Uses

type CreateDBClusterSnapshotInput struct {

    // The identifier of the DB 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 DB 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 DB cluster snapshot.
    Tags []*Tag `locationNameList:"Tag" type:"list"`
    // contains filtered or unexported fields
}

Represents the input of CreateDBClusterSnapshot.

func (CreateDBClusterSnapshotInput) GoString Uses

func (s CreateDBClusterSnapshotInput) GoString() string

GoString returns the string representation

func (*CreateDBClusterSnapshotInput) SetDBClusterIdentifier Uses

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*CreateDBClusterSnapshotInput) SetDBClusterSnapshotIdentifier Uses

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

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (*CreateDBClusterSnapshotInput) SetTags Uses

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

SetTags sets the Tags field's value.

func (CreateDBClusterSnapshotInput) String Uses

func (s CreateDBClusterSnapshotInput) String() string

String returns the string representation

func (*CreateDBClusterSnapshotInput) Validate Uses

func (s *CreateDBClusterSnapshotInput) Validate() error

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

type CreateDBClusterSnapshotOutput Uses

type CreateDBClusterSnapshotOutput struct {

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

func (CreateDBClusterSnapshotOutput) GoString Uses

func (s CreateDBClusterSnapshotOutput) GoString() string

GoString returns the string representation

func (*CreateDBClusterSnapshotOutput) SetDBClusterSnapshot Uses

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

SetDBClusterSnapshot sets the DBClusterSnapshot field's value.

func (CreateDBClusterSnapshotOutput) String Uses

func (s CreateDBClusterSnapshotOutput) String() string

String returns the string representation

type CreateDBInstanceInput Uses

type CreateDBInstanceInput struct {

    // Indicates that minor engine upgrades are applied automatically to the DB
    // instance during the maintenance window.
    //
    // Default: true
    AutoMinorVersionUpgrade *bool `type:"boolean"`

    // The Amazon EC2 Availability Zone that the DB instance is created in.
    //
    // Default: A random, system-chosen Availability Zone in the endpoint's AWS
    // Region.
    //
    // Example: us-east-1d
    //
    // Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ
    // parameter is set to true. The specified Availability Zone must be in the
    // same AWS Region as the current endpoint.
    AvailabilityZone *string `type:"string"`

    // The identifier of the DB 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 DB instance; for example, db.r5.large.
    //
    // DBInstanceClass is a required field
    DBInstanceClass *string `type:"string" required:"true"`

    // The DB 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"`

    // 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 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 AWS 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 DB instance.
    Tags []*Tag `locationNameList:"Tag" type:"list"`
    // contains filtered or unexported fields
}

Represents the input to CreateDBInstance.

func (CreateDBInstanceInput) GoString Uses

func (s CreateDBInstanceInput) GoString() string

GoString returns the string representation

func (*CreateDBInstanceInput) SetAutoMinorVersionUpgrade Uses

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*CreateDBInstanceInput) SetAvailabilityZone Uses

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

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*CreateDBInstanceInput) SetDBClusterIdentifier Uses

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*CreateDBInstanceInput) SetDBInstanceClass Uses

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

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*CreateDBInstanceInput) SetDBInstanceIdentifier Uses

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*CreateDBInstanceInput) SetEngine Uses

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

SetEngine sets the Engine field's value.

func (*CreateDBInstanceInput) SetPreferredMaintenanceWindow Uses

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*CreateDBInstanceInput) SetPromotionTier Uses

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

SetPromotionTier sets the PromotionTier field's value.

func (*CreateDBInstanceInput) SetTags Uses

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

SetTags sets the Tags field's value.

func (CreateDBInstanceInput) String Uses

func (s CreateDBInstanceInput) String() string

String returns the string representation

func (*CreateDBInstanceInput) Validate Uses

func (s *CreateDBInstanceInput) Validate() error

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

type CreateDBInstanceOutput Uses

type CreateDBInstanceOutput struct {

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

func (CreateDBInstanceOutput) GoString Uses

func (s CreateDBInstanceOutput) GoString() string

GoString returns the string representation

func (*CreateDBInstanceOutput) SetDBInstance Uses

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

SetDBInstance sets the DBInstance field's value.

func (CreateDBInstanceOutput) String Uses

func (s CreateDBInstanceOutput) String() string

String returns the string representation

type CreateDBSubnetGroupInput Uses

type CreateDBSubnetGroupInput struct {

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

    // The name for the DB 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 DB subnet group.
    //
    // SubnetIds is a required field
    SubnetIds []*string `locationNameList:"SubnetIdentifier" type:"list" required:"true"`

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

Represents the input to CreateDBSubnetGroup.

func (CreateDBSubnetGroupInput) GoString Uses

func (s CreateDBSubnetGroupInput) GoString() string

GoString returns the string representation

func (*CreateDBSubnetGroupInput) SetDBSubnetGroupDescription Uses

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

SetDBSubnetGroupDescription sets the DBSubnetGroupDescription field's value.

func (*CreateDBSubnetGroupInput) SetDBSubnetGroupName Uses

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

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*CreateDBSubnetGroupInput) SetSubnetIds Uses

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

SetSubnetIds sets the SubnetIds field's value.

func (*CreateDBSubnetGroupInput) SetTags Uses

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

SetTags sets the Tags field's value.

func (CreateDBSubnetGroupInput) String Uses

func (s CreateDBSubnetGroupInput) String() string

String returns the string representation

func (*CreateDBSubnetGroupInput) Validate Uses

func (s *CreateDBSubnetGroupInput) Validate() error

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

type CreateDBSubnetGroupOutput Uses

type CreateDBSubnetGroupOutput struct {

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

func (CreateDBSubnetGroupOutput) GoString Uses

func (s CreateDBSubnetGroupOutput) GoString() string

GoString returns the string representation

func (*CreateDBSubnetGroupOutput) SetDBSubnetGroup Uses

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

SetDBSubnetGroup sets the DBSubnetGroup field's value.

func (CreateDBSubnetGroupOutput) String Uses

func (s CreateDBSubnetGroupOutput) String() string

String returns the string representation

type DBCluster Uses

type DBCluster struct {

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

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

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

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

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

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

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

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

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

    // The AWS Region-unique, immutable identifier for the DB cluster. This identifier
    // is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB
    // 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 DB cluster is configured to export to Amazon
    // CloudWatch Logs.
    EnabledCloudwatchLogsExports []*string `type:"list"`

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

    // Provides the name of the database engine to be used for this DB 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 AWS KMS key identifier for the encrypted
    // DB 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 DB cluster.
    MasterUsername *string `type:"string"`

    // Specifies whether the DB 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"`

    // The reader endpoint for the DB cluster. The reader endpoint for a DB cluster
    // load balances connections across the Amazon DocumentDB replicas that are
    // available in a DB cluster. As clients request new connections to the reader
    // endpoint, Amazon DocumentDB distributes the connection requests among the
    // Amazon DocumentDB replicas in the DB cluster. This functionality can help
    // balance your read workload across multiple Amazon DocumentDB replicas in
    // your DB 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"`

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

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

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

Detailed information about a DB cluster.

func (DBCluster) GoString Uses

func (s DBCluster) GoString() string

GoString returns the string representation

func (*DBCluster) SetAssociatedRoles Uses

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

SetAssociatedRoles sets the AssociatedRoles field's value.

func (*DBCluster) SetAvailabilityZones Uses

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

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*DBCluster) SetBackupRetentionPeriod Uses

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*DBCluster) SetClusterCreateTime Uses

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

SetClusterCreateTime sets the ClusterCreateTime field's value.

func (*DBCluster) SetDBClusterArn Uses

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

SetDBClusterArn sets the DBClusterArn field's value.

func (*DBCluster) SetDBClusterIdentifier Uses

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DBCluster) SetDBClusterMembers Uses

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

SetDBClusterMembers sets the DBClusterMembers field's value.

func (*DBCluster) SetDBClusterParameterGroup Uses

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

SetDBClusterParameterGroup sets the DBClusterParameterGroup field's value.

func (*DBCluster) SetDBSubnetGroup Uses

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

SetDBSubnetGroup sets the DBSubnetGroup field's value.

func (*DBCluster) SetDbClusterResourceId Uses

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

SetDbClusterResourceId sets the DbClusterResourceId field's value.

func (*DBCluster) SetDeletionProtection Uses

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

SetDeletionProtection sets the DeletionProtection field's value.

func (*DBCluster) SetEarliestRestorableTime Uses

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

SetEarliestRestorableTime sets the EarliestRestorableTime field's value.

func (*DBCluster) SetEnabledCloudwatchLogsExports Uses

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

SetEnabledCloudwatchLogsExports sets the EnabledCloudwatchLogsExports field's value.

func (*DBCluster) SetEndpoint Uses

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

SetEndpoint sets the Endpoint field's value.

func (*DBCluster) SetEngine Uses

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

SetEngine sets the Engine field's value.

func (*DBCluster) SetEngineVersion Uses

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

SetEngineVersion sets the EngineVersion field's value.

func (*DBCluster) SetHostedZoneId Uses

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

SetHostedZoneId sets the HostedZoneId field's value.

func (*DBCluster) SetKmsKeyId Uses

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*DBCluster) SetLatestRestorableTime Uses

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

SetLatestRestorableTime sets the LatestRestorableTime field's value.

func (*DBCluster) SetMasterUsername Uses

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

SetMasterUsername sets the MasterUsername field's value.

func (*DBCluster) SetMultiAZ Uses

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

SetMultiAZ sets the MultiAZ field's value.

func (*DBCluster) SetPercentProgress Uses

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

SetPercentProgress sets the PercentProgress field's value.

func (*DBCluster) SetPort Uses

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

SetPort sets the Port field's value.

func (*DBCluster) SetPreferredBackupWindow Uses

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*DBCluster) SetPreferredMaintenanceWindow Uses

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*DBCluster) SetReaderEndpoint Uses

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

SetReaderEndpoint sets the ReaderEndpoint field's value.

func (*DBCluster) SetStatus Uses

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

SetStatus sets the Status field's value.

func (*DBCluster) SetStorageEncrypted Uses

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

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*DBCluster) SetVpcSecurityGroups Uses

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

SetVpcSecurityGroups sets the VpcSecurityGroups field's value.

func (DBCluster) String Uses

func (s DBCluster) String() string

String returns the string representation

type DBClusterMember Uses

type DBClusterMember struct {

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

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

    // A value that is true if the cluster member is the primary instance for the
    // DB 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 DB cluster.

func (DBClusterMember) GoString Uses

func (s DBClusterMember) GoString() string

GoString returns the string representation

func (*DBClusterMember) SetDBClusterParameterGroupStatus Uses

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

SetDBClusterParameterGroupStatus sets the DBClusterParameterGroupStatus field's value.

func (*DBClusterMember) SetDBInstanceIdentifier Uses

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*DBClusterMember) SetIsClusterWriter Uses

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

SetIsClusterWriter sets the IsClusterWriter field's value.

func (*DBClusterMember) SetPromotionTier Uses

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

SetPromotionTier sets the PromotionTier field's value.

func (DBClusterMember) String Uses

func (s DBClusterMember) String() string

String returns the string representation

type DBClusterParameterGroup Uses

type DBClusterParameterGroup struct {

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

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

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

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

Detailed information about a DB cluster parameter group.

func (DBClusterParameterGroup) GoString Uses

func (s DBClusterParameterGroup) GoString() string

GoString returns the string representation

func (*DBClusterParameterGroup) SetDBClusterParameterGroupArn Uses

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

SetDBClusterParameterGroupArn sets the DBClusterParameterGroupArn field's value.

func (*DBClusterParameterGroup) SetDBClusterParameterGroupName Uses

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

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*DBClusterParameterGroup) SetDBParameterGroupFamily Uses

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

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*DBClusterParameterGroup) SetDescription Uses

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

SetDescription sets the Description field's value.

func (DBClusterParameterGroup) String Uses

func (s DBClusterParameterGroup) String() string

String returns the string representation

type DBClusterRole Uses

type DBClusterRole struct {

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

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

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

func (DBClusterRole) GoString Uses

func (s DBClusterRole) GoString() string

GoString returns the string representation

func (*DBClusterRole) SetRoleArn Uses

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

SetRoleArn sets the RoleArn field's value.

func (*DBClusterRole) SetStatus Uses

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

SetStatus sets the Status field's value.

func (DBClusterRole) String Uses

func (s DBClusterRole) String() string

String returns the string representation

type DBClusterSnapshot Uses

type DBClusterSnapshot struct {

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

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

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

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

    // Specifies the identifier for the DB 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 DB cluster snapshot.
    EngineVersion *string `type:"string"`

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

    // Provides the master user name for the DB 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 DB 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 DB cluster snapshot.
    SnapshotType *string `type:"string"`

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

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

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

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

Detailed information about a DB cluster snapshot.

func (DBClusterSnapshot) GoString Uses

func (s DBClusterSnapshot) GoString() string

GoString returns the string representation

func (*DBClusterSnapshot) SetAvailabilityZones Uses

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

SetAvailabilityZones sets the AvailabilityZones field's value.

func (*DBClusterSnapshot) SetClusterCreateTime Uses

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

SetClusterCreateTime sets the ClusterCreateTime field's value.

func (*DBClusterSnapshot) SetDBClusterIdentifier Uses

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DBClusterSnapshot) SetDBClusterSnapshotArn Uses

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

SetDBClusterSnapshotArn sets the DBClusterSnapshotArn field's value.

func (*DBClusterSnapshot) SetDBClusterSnapshotIdentifier Uses

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

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (*DBClusterSnapshot) SetEngine Uses

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

SetEngine sets the Engine field's value.

func (*DBClusterSnapshot) SetEngineVersion Uses

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

SetEngineVersion sets the EngineVersion field's value.

func (*DBClusterSnapshot) SetKmsKeyId Uses

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*DBClusterSnapshot) SetMasterUsername Uses

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

SetMasterUsername sets the MasterUsername field's value.

func (*DBClusterSnapshot) SetPercentProgress Uses

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

SetPercentProgress sets the PercentProgress field's value.

func (*DBClusterSnapshot) SetPort Uses

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

SetPort sets the Port field's value.

func (*DBClusterSnapshot) SetSnapshotCreateTime Uses

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

SetSnapshotCreateTime sets the SnapshotCreateTime field's value.

func (*DBClusterSnapshot) SetSnapshotType Uses

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

SetSnapshotType sets the SnapshotType field's value.

func (*DBClusterSnapshot) SetSourceDBClusterSnapshotArn Uses

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

SetSourceDBClusterSnapshotArn sets the SourceDBClusterSnapshotArn field's value.

func (*DBClusterSnapshot) SetStatus Uses

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

SetStatus sets the Status field's value.

func (*DBClusterSnapshot) SetStorageEncrypted Uses

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

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*DBClusterSnapshot) SetVpcId Uses

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

SetVpcId sets the VpcId field's value.

func (DBClusterSnapshot) String Uses

func (s DBClusterSnapshot) String() string

String returns the string representation

type DBClusterSnapshotAttribute Uses

type DBClusterSnapshotAttribute struct {

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

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

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

Manual DB cluster snapshot attributes are used to authorize other AWS accounts to restore a manual DB cluster snapshot.

func (DBClusterSnapshotAttribute) GoString Uses

func (s DBClusterSnapshotAttribute) GoString() string

GoString returns the string representation

func (*DBClusterSnapshotAttribute) SetAttributeName Uses

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

SetAttributeName sets the AttributeName field's value.

func (*DBClusterSnapshotAttribute) SetAttributeValues Uses

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

SetAttributeValues sets the AttributeValues field's value.

func (DBClusterSnapshotAttribute) String Uses

func (s DBClusterSnapshotAttribute) String() string

String returns the string representation

type DBClusterSnapshotAttributesResult Uses

type DBClusterSnapshotAttributesResult struct {

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

    // The identifier of the DB 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 DB cluster snapshot.

func (DBClusterSnapshotAttributesResult) GoString Uses

func (s DBClusterSnapshotAttributesResult) GoString() string

GoString returns the string representation

func (*DBClusterSnapshotAttributesResult) SetDBClusterSnapshotAttributes Uses

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

SetDBClusterSnapshotAttributes sets the DBClusterSnapshotAttributes field's value.

func (*DBClusterSnapshotAttributesResult) SetDBClusterSnapshotIdentifier Uses

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

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (DBClusterSnapshotAttributesResult) String Uses

func (s DBClusterSnapshotAttributesResult) String() string

String returns the string representation

type DBEngineVersion Uses

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 DB 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 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 a DB engine version.

func (DBEngineVersion) GoString Uses

func (s DBEngineVersion) GoString() string

GoString returns the string representation

func (*DBEngineVersion) SetDBEngineDescription Uses

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

SetDBEngineDescription sets the DBEngineDescription field's value.

func (*DBEngineVersion) SetDBEngineVersionDescription Uses

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

SetDBEngineVersionDescription sets the DBEngineVersionDescription field's value.

func (*DBEngineVersion) SetDBParameterGroupFamily Uses

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

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*DBEngineVersion) SetEngine Uses

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

SetEngine sets the Engine field's value.

func (*DBEngineVersion) SetEngineVersion Uses

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

SetEngineVersion sets the EngineVersion field's value.

func (*DBEngineVersion) SetExportableLogTypes Uses

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

SetExportableLogTypes sets the ExportableLogTypes field's value.

func (*DBEngineVersion) SetSupportsLogExportsToCloudwatchLogs Uses

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

SetSupportsLogExportsToCloudwatchLogs sets the SupportsLogExportsToCloudwatchLogs field's value.

func (*DBEngineVersion) SetValidUpgradeTarget Uses

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

SetValidUpgradeTarget sets the ValidUpgradeTarget field's value.

func (DBEngineVersion) String Uses

func (s DBEngineVersion) String() string

String returns the string representation

type DBInstance Uses

type DBInstance struct {

    // Indicates that minor version patches are applied automatically.
    AutoMinorVersionUpgrade *bool `type:"boolean"`

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

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

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

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

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

    // Contains a user-provided database identifier. This identifier is the unique
    // key that identifies a DB 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 DB
    // instance, including the name, description, and subnets in the subnet group.
    DBSubnetGroup *DBSubnetGroup `type:"structure"`

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

    // A list of log types that this DB instance is configured to export to Amazon
    // 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 DB instance.
    Engine *string `type:"string"`

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

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

    // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted
    // DB 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 DB instance are pending. This element is included
    // only when changes are pending. Specific changes are identified by subelements.
    PendingModifiedValues *PendingModifiedValues `type:"structure"`

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

    // Specifies the availability options for the DB instance. A value of true specifies
    // an internet-facing instance with a publicly resolvable DNS name, which resolves
    // to a public IP address. A value of false specifies an internal instance with
    // a DNS name that resolves to a private IP address.
    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 the DB instance is encrypted.
    StorageEncrypted *bool `type:"boolean"`

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

Detailed information about a DB instance.

func (DBInstance) GoString Uses

func (s DBInstance) GoString() string

GoString returns the string representation

func (*DBInstance) SetAutoMinorVersionUpgrade Uses

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

SetAutoMinorVersionUpgrade sets the AutoMinorVersionUpgrade field's value.

func (*DBInstance) SetAvailabilityZone Uses

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

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*DBInstance) SetBackupRetentionPeriod Uses

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

SetBackupRetentionPeriod sets the BackupRetentionPeriod field's value.

func (*DBInstance) SetDBClusterIdentifier Uses

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DBInstance) SetDBInstanceArn Uses

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

SetDBInstanceArn sets the DBInstanceArn field's value.

func (*DBInstance) SetDBInstanceClass Uses

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

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*DBInstance) SetDBInstanceIdentifier Uses

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*DBInstance) SetDBInstanceStatus Uses

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

SetDBInstanceStatus sets the DBInstanceStatus field's value.

func (*DBInstance) SetDBSubnetGroup Uses

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

SetDBSubnetGroup sets the DBSubnetGroup field's value.

func (*DBInstance) SetDbiResourceId Uses

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

SetDbiResourceId sets the DbiResourceId field's value.

func (*DBInstance) SetEnabledCloudwatchLogsExports Uses

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

SetEnabledCloudwatchLogsExports sets the EnabledCloudwatchLogsExports field's value.

func (*DBInstance) SetEndpoint Uses

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

SetEndpoint sets the Endpoint field's value.

func (*DBInstance) SetEngine Uses

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

SetEngine sets the Engine field's value.

func (*DBInstance) SetEngineVersion Uses

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

SetEngineVersion sets the EngineVersion field's value.

func (*DBInstance) SetInstanceCreateTime Uses

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

SetInstanceCreateTime sets the InstanceCreateTime field's value.

func (*DBInstance) SetKmsKeyId Uses

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

SetKmsKeyId sets the KmsKeyId field's value.

func (*DBInstance) SetLatestRestorableTime Uses

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

SetLatestRestorableTime sets the LatestRestorableTime field's value.

func (*DBInstance) SetPendingModifiedValues Uses

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

SetPendingModifiedValues sets the PendingModifiedValues field's value.

func (*DBInstance) SetPreferredBackupWindow Uses

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

SetPreferredBackupWindow sets the PreferredBackupWindow field's value.

func (*DBInstance) SetPreferredMaintenanceWindow Uses

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

SetPreferredMaintenanceWindow sets the PreferredMaintenanceWindow field's value.

func (*DBInstance) SetPromotionTier Uses

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

SetPromotionTier sets the PromotionTier field's value.

func (*DBInstance) SetPubliclyAccessible Uses

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

SetPubliclyAccessible sets the PubliclyAccessible field's value.

func (*DBInstance) SetStatusInfos Uses

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

SetStatusInfos sets the StatusInfos field's value.

func (*DBInstance) SetStorageEncrypted Uses

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

SetStorageEncrypted sets the StorageEncrypted field's value.

func (*DBInstance) SetVpcSecurityGroups Uses

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

SetVpcSecurityGroups sets the VpcSecurityGroups field's value.

func (DBInstance) String Uses

func (s DBInstance) String() string

String returns the string representation

type DBInstanceStatusInfo Uses

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 DB 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 a DB instance.

func (DBInstanceStatusInfo) GoString Uses

func (s DBInstanceStatusInfo) GoString() string

GoString returns the string representation

func (*DBInstanceStatusInfo) SetMessage Uses

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

SetMessage sets the Message field's value.

func (*DBInstanceStatusInfo) SetNormal Uses

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

SetNormal sets the Normal field's value.

func (*DBInstanceStatusInfo) SetStatus Uses

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

SetStatus sets the Status field's value.

func (*DBInstanceStatusInfo) SetStatusType Uses

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

SetStatusType sets the StatusType field's value.

func (DBInstanceStatusInfo) String Uses

func (s DBInstanceStatusInfo) String() string

String returns the string representation

type DBSubnetGroup Uses

type DBSubnetGroup struct {

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

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

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

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

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

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

Detailed information about a DB subnet group.

func (DBSubnetGroup) GoString Uses

func (s DBSubnetGroup) GoString() string

GoString returns the string representation

func (*DBSubnetGroup) SetDBSubnetGroupArn Uses

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

SetDBSubnetGroupArn sets the DBSubnetGroupArn field's value.

func (*DBSubnetGroup) SetDBSubnetGroupDescription Uses

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

SetDBSubnetGroupDescription sets the DBSubnetGroupDescription field's value.

func (*DBSubnetGroup) SetDBSubnetGroupName Uses

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

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*DBSubnetGroup) SetSubnetGroupStatus Uses

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

SetSubnetGroupStatus sets the SubnetGroupStatus field's value.

func (*DBSubnetGroup) SetSubnets Uses

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

SetSubnets sets the Subnets field's value.

func (*DBSubnetGroup) SetVpcId Uses

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

SetVpcId sets the VpcId field's value.

func (DBSubnetGroup) String Uses

func (s DBSubnetGroup) String() string

String returns the string representation

type DeleteDBClusterInput Uses

type DeleteDBClusterInput struct {

    // The DB cluster identifier for the DB 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 DB cluster snapshot identifier of the new DB 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 DB cluster snapshot is created before the DB cluster
    // is deleted. If true is specified, no DB cluster snapshot is created. If false
    // is specified, a DB 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 Uses

func (s DeleteDBClusterInput) GoString() string

GoString returns the string representation

func (*DeleteDBClusterInput) SetDBClusterIdentifier Uses

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DeleteDBClusterInput) SetFinalDBSnapshotIdentifier Uses

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

SetFinalDBSnapshotIdentifier sets the FinalDBSnapshotIdentifier field's value.

func (*DeleteDBClusterInput) SetSkipFinalSnapshot Uses

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

SetSkipFinalSnapshot sets the SkipFinalSnapshot field's value.

func (DeleteDBClusterInput) String Uses

func (s DeleteDBClusterInput) String() string

String returns the string representation

func (*DeleteDBClusterInput) Validate Uses

func (s *DeleteDBClusterInput) Validate() error

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

type DeleteDBClusterOutput Uses

type DeleteDBClusterOutput struct {

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

func (DeleteDBClusterOutput) GoString Uses

func (s DeleteDBClusterOutput) GoString() string

GoString returns the string representation

func (*DeleteDBClusterOutput) SetDBCluster Uses

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

SetDBCluster sets the DBCluster field's value.

func (DeleteDBClusterOutput) String Uses

func (s DeleteDBClusterOutput) String() string

String returns the string representation

type DeleteDBClusterParameterGroupInput Uses

type DeleteDBClusterParameterGroupInput struct {

    // The name of the DB cluster parameter group.
    //
    // Constraints:
    //
    //    * Must be the name of an existing DB cluster parameter group.
    //
    //    * You can't delete a default DB cluster parameter group.
    //
    //    * Cannot be associated with any DB 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 Uses

func (s DeleteDBClusterParameterGroupInput) GoString() string

GoString returns the string representation

func (*DeleteDBClusterParameterGroupInput) SetDBClusterParameterGroupName Uses

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

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (DeleteDBClusterParameterGroupInput) String Uses

func (s DeleteDBClusterParameterGroupInput) String() string

String returns the string representation

func (*DeleteDBClusterParameterGroupInput) Validate Uses

func (s *DeleteDBClusterParameterGroupInput) Validate() error

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

type DeleteDBClusterParameterGroupOutput Uses

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

func (DeleteDBClusterParameterGroupOutput) GoString Uses

func (s DeleteDBClusterParameterGroupOutput) GoString() string

GoString returns the string representation

func (DeleteDBClusterParameterGroupOutput) String Uses

func (s DeleteDBClusterParameterGroupOutput) String() string

String returns the string representation

type DeleteDBClusterSnapshotInput Uses

type DeleteDBClusterSnapshotInput struct {

    // The identifier of the DB cluster snapshot to delete.
    //
    // Constraints: Must be the name of an existing DB 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 Uses

func (s DeleteDBClusterSnapshotInput) GoString() string

GoString returns the string representation

func (*DeleteDBClusterSnapshotInput) SetDBClusterSnapshotIdentifier Uses

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

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (DeleteDBClusterSnapshotInput) String Uses

func (s DeleteDBClusterSnapshotInput) String() string

String returns the string representation

func (*DeleteDBClusterSnapshotInput) Validate Uses

func (s *DeleteDBClusterSnapshotInput) Validate() error

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

type DeleteDBClusterSnapshotOutput Uses

type DeleteDBClusterSnapshotOutput struct {

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

func (DeleteDBClusterSnapshotOutput) GoString Uses

func (s DeleteDBClusterSnapshotOutput) GoString() string

GoString returns the string representation

func (*DeleteDBClusterSnapshotOutput) SetDBClusterSnapshot Uses

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

SetDBClusterSnapshot sets the DBClusterSnapshot field's value.

func (DeleteDBClusterSnapshotOutput) String Uses

func (s DeleteDBClusterSnapshotOutput) String() string

String returns the string representation

type DeleteDBInstanceInput Uses

type DeleteDBInstanceInput struct {

    // The DB instance identifier for the DB instance to be deleted. This parameter
    // isn't case sensitive.
    //
    // Constraints:
    //
    //    * Must match the name of an existing DB 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 Uses

func (s DeleteDBInstanceInput) GoString() string

GoString returns the string representation

func (*DeleteDBInstanceInput) SetDBInstanceIdentifier Uses

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (DeleteDBInstanceInput) String Uses

func (s DeleteDBInstanceInput) String() string

String returns the string representation

func (*DeleteDBInstanceInput) Validate Uses

func (s *DeleteDBInstanceInput) Validate() error

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

type DeleteDBInstanceOutput Uses

type DeleteDBInstanceOutput struct {

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

func (DeleteDBInstanceOutput) GoString Uses

func (s DeleteDBInstanceOutput) GoString() string

GoString returns the string representation

func (*DeleteDBInstanceOutput) SetDBInstance Uses

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

SetDBInstance sets the DBInstance field's value.

func (DeleteDBInstanceOutput) String Uses

func (s DeleteDBInstanceOutput) String() string

String returns the string representation

type DeleteDBSubnetGroupInput Uses

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 Uses

func (s DeleteDBSubnetGroupInput) GoString() string

GoString returns the string representation

func (*DeleteDBSubnetGroupInput) SetDBSubnetGroupName Uses

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

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (DeleteDBSubnetGroupInput) String Uses

func (s DeleteDBSubnetGroupInput) String() string

String returns the string representation

func (*DeleteDBSubnetGroupInput) Validate Uses

func (s *DeleteDBSubnetGroupInput) Validate() error

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

type DeleteDBSubnetGroupOutput Uses

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

func (DeleteDBSubnetGroupOutput) GoString Uses

func (s DeleteDBSubnetGroupOutput) GoString() string

GoString returns the string representation

func (DeleteDBSubnetGroupOutput) String Uses

func (s DeleteDBSubnetGroupOutput) String() string

String returns the string representation

type DescribeDBClusterParameterGroupsInput Uses

type DescribeDBClusterParameterGroupsInput struct {

    // The name of a specific DB 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 Uses

func (s DescribeDBClusterParameterGroupsInput) GoString() string

GoString returns the string representation

func (*DescribeDBClusterParameterGroupsInput) SetDBClusterParameterGroupName Uses

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

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*DescribeDBClusterParameterGroupsInput) SetFilters Uses

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

SetFilters sets the Filters field's value.

func (*DescribeDBClusterParameterGroupsInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeDBClusterParameterGroupsInput) SetMaxRecords Uses

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

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBClusterParameterGroupsInput) String Uses

func (s DescribeDBClusterParameterGroupsInput) String() string

String returns the string representation

func (*DescribeDBClusterParameterGroupsInput) Validate Uses

func (s *DescribeDBClusterParameterGroupsInput) Validate() error

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

type DescribeDBClusterParameterGroupsOutput Uses

type DescribeDBClusterParameterGroupsOutput struct {

    // A list of DB 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 Uses

func (s DescribeDBClusterParameterGroupsOutput) GoString() string

GoString returns the string representation

func (*DescribeDBClusterParameterGroupsOutput) SetDBClusterParameterGroups Uses

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

SetDBClusterParameterGroups sets the DBClusterParameterGroups field's value.

func (*DescribeDBClusterParameterGroupsOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (DescribeDBClusterParameterGroupsOutput) String Uses

func (s DescribeDBClusterParameterGroupsOutput) String() string

String returns the string representation

type DescribeDBClusterParametersInput Uses

type DescribeDBClusterParametersInput struct {

    // The name of a specific DB 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 Uses

func (s DescribeDBClusterParametersInput) GoString() string

GoString returns the string representation

func (*DescribeDBClusterParametersInput) SetDBClusterParameterGroupName Uses

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

SetDBClusterParameterGroupName sets the DBClusterParameterGroupName field's value.

func (*DescribeDBClusterParametersInput) SetFilters Uses

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

SetFilters sets the Filters field's value.

func (*DescribeDBClusterParametersInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeDBClusterParametersInput) SetMaxRecords Uses

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

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeDBClusterParametersInput) SetSource Uses

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

SetSource sets the Source field's value.

func (DescribeDBClusterParametersInput) String Uses

func (s DescribeDBClusterParametersInput) String() string

String returns the string representation

func (*DescribeDBClusterParametersInput) Validate Uses

func (s *DescribeDBClusterParametersInput) Validate() error

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

type DescribeDBClusterParametersOutput Uses

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 DB cluster parameter group.
    Parameters []*Parameter `locationNameList:"Parameter" type:"list"`
    // contains filtered or unexported fields
}

Represents the output of DBClusterParameterGroup.

func (DescribeDBClusterParametersOutput) GoString Uses

func (s DescribeDBClusterParametersOutput) GoString() string

GoString returns the string representation

func (*DescribeDBClusterParametersOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeDBClusterParametersOutput) SetParameters Uses

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

SetParameters sets the Parameters field's value.

func (DescribeDBClusterParametersOutput) String Uses

func (s DescribeDBClusterParametersOutput) String() string

String returns the string representation

type DescribeDBClusterSnapshotAttributesInput Uses

type DescribeDBClusterSnapshotAttributesInput struct {

    // The identifier for the DB 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 Uses

func (s DescribeDBClusterSnapshotAttributesInput) GoString() string

GoString returns the string representation

func (*DescribeDBClusterSnapshotAttributesInput) SetDBClusterSnapshotIdentifier Uses

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

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (DescribeDBClusterSnapshotAttributesInput) String Uses

func (s DescribeDBClusterSnapshotAttributesInput) String() string

String returns the string representation

func (*DescribeDBClusterSnapshotAttributesInput) Validate Uses

func (s *DescribeDBClusterSnapshotAttributesInput) Validate() error

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

type DescribeDBClusterSnapshotAttributesOutput Uses

type DescribeDBClusterSnapshotAttributesOutput struct {

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

func (DescribeDBClusterSnapshotAttributesOutput) GoString Uses

func (s DescribeDBClusterSnapshotAttributesOutput) GoString() string

GoString returns the string representation

func (*DescribeDBClusterSnapshotAttributesOutput) SetDBClusterSnapshotAttributesResult Uses

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

SetDBClusterSnapshotAttributesResult sets the DBClusterSnapshotAttributesResult field's value.

func (DescribeDBClusterSnapshotAttributesOutput) String Uses

func (s DescribeDBClusterSnapshotAttributesOutput) String() string

String returns the string representation

type DescribeDBClusterSnapshotsInput Uses

type DescribeDBClusterSnapshotsInput struct {

    // The ID of the DB cluster to retrieve the list of DB 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 DB 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 DB cluster snapshots that are public and can
    // be copied or restored by any AWS account, and otherwise false. The default
    // is false.
    IncludePublic *bool `type:"boolean"`

    // Set to true to include shared manual DB cluster snapshots from other AWS
    // accounts that this AWS 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 DB cluster snapshots to be returned. You can specify one of the
    // following values:
    //
    //    * automated - Return all DB cluster snapshots that Amazon DocumentDB has
    //    automatically created for your AWS account.
    //
    //    * manual - Return all DB cluster snapshots that you have manually created
    //    for your AWS account.
    //
    //    * shared - Return all manual DB cluster snapshots that have been shared
    //    to your AWS account.
    //
    //    * public - Return all DB cluster snapshots that have been marked as public.
    //
    // If you don't specify a SnapshotType value, then both automated and manual
    // DB cluster snapshots are returned. You can include shared DB cluster snapshots
    // with these results by setting the IncludeShared parameter to true. You can
    // include public DB cluster snapshots with these results by setting the IncludePublic
    // 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 Uses

func (s DescribeDBClusterSnapshotsInput) GoString() string

GoString returns the string representation

func (*DescribeDBClusterSnapshotsInput) SetDBClusterIdentifier Uses

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DescribeDBClusterSnapshotsInput) SetDBClusterSnapshotIdentifier Uses

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

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

func (*DescribeDBClusterSnapshotsInput) SetFilters Uses

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

SetFilters sets the Filters field's value.

func (*DescribeDBClusterSnapshotsInput) SetIncludePublic Uses

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

SetIncludePublic sets the IncludePublic field's value.

func (*DescribeDBClusterSnapshotsInput) SetIncludeShared Uses

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

SetIncludeShared sets the IncludeShared field's value.

func (*DescribeDBClusterSnapshotsInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeDBClusterSnapshotsInput) SetMaxRecords Uses

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

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeDBClusterSnapshotsInput) SetSnapshotType Uses

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

SetSnapshotType sets the SnapshotType field's value.

func (DescribeDBClusterSnapshotsInput) String Uses

func (s DescribeDBClusterSnapshotsInput) String() string

String returns the string representation

func (*DescribeDBClusterSnapshotsInput) Validate Uses

func (s *DescribeDBClusterSnapshotsInput) Validate() error

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

type DescribeDBClusterSnapshotsOutput Uses

type DescribeDBClusterSnapshotsOutput struct {

    // Provides a list of DB 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 Uses

func (s DescribeDBClusterSnapshotsOutput) GoString() string

GoString returns the string representation

func (*DescribeDBClusterSnapshotsOutput) SetDBClusterSnapshots Uses

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

SetDBClusterSnapshots sets the DBClusterSnapshots field's value.

func (*DescribeDBClusterSnapshotsOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (DescribeDBClusterSnapshotsOutput) String Uses

func (s DescribeDBClusterSnapshotsOutput) String() string

String returns the string representation

type DescribeDBClustersInput Uses

type DescribeDBClustersInput struct {

    // The user-provided DB cluster identifier. If this parameter is specified,
    // information from only the specific DB 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 DB clusters to describe.
    //
    // Supported filters:
    //
    //    * db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon
    //    Resource Names (ARNs). The results list only includes information about
    //    the DB 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 Uses

func (s DescribeDBClustersInput) GoString() string

GoString returns the string representation

func (*DescribeDBClustersInput) SetDBClusterIdentifier Uses

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

func (*DescribeDBClustersInput) SetFilters Uses

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

SetFilters sets the Filters field's value.

func (*DescribeDBClustersInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeDBClustersInput) SetMaxRecords Uses

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

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBClustersInput) String Uses

func (s DescribeDBClustersInput) String() string

String returns the string representation

func (*DescribeDBClustersInput) Validate Uses

func (s *DescribeDBClustersInput) Validate() error

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

type DescribeDBClustersOutput Uses

type DescribeDBClustersOutput struct {

    // A list of DB 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 Uses

func (s DescribeDBClustersOutput) GoString() string

GoString returns the string representation

func (*DescribeDBClustersOutput) SetDBClusters Uses

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

SetDBClusters sets the DBClusters field's value.

func (*DescribeDBClustersOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (DescribeDBClustersOutput) String Uses

func (s DescribeDBClustersOutput) String() string

String returns the string representation

type DescribeDBEngineVersionsInput Uses

type DescribeDBEngineVersionsInput struct {

    // The name of a specific DB 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: 5.1.49
    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 Uses

func (s DescribeDBEngineVersionsInput) GoString() string

GoString returns the string representation

func (*DescribeDBEngineVersionsInput) SetDBParameterGroupFamily Uses

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

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*DescribeDBEngineVersionsInput) SetDefaultOnly Uses

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

SetDefaultOnly sets the DefaultOnly field's value.

func (*DescribeDBEngineVersionsInput) SetEngine Uses

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

SetEngine sets the Engine field's value.

func (*DescribeDBEngineVersionsInput) SetEngineVersion Uses

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

SetEngineVersion sets the EngineVersion field's value.

func (*DescribeDBEngineVersionsInput) SetFilters Uses

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

SetFilters sets the Filters field's value.

func (*DescribeDBEngineVersionsInput) SetListSupportedCharacterSets Uses

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

SetListSupportedCharacterSets sets the ListSupportedCharacterSets field's value.

func (*DescribeDBEngineVersionsInput) SetListSupportedTimezones Uses

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

SetListSupportedTimezones sets the ListSupportedTimezones field's value.

func (*DescribeDBEngineVersionsInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeDBEngineVersionsInput) SetMaxRecords Uses

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

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBEngineVersionsInput) String Uses

func (s DescribeDBEngineVersionsInput) String() string

String returns the string representation

func (*DescribeDBEngineVersionsInput) Validate Uses

func (s *DescribeDBEngineVersionsInput) Validate() error

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

type DescribeDBEngineVersionsOutput Uses

type DescribeDBEngineVersionsOutput struct {

    // Detailed information about one or more DB 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 Uses

func (s DescribeDBEngineVersionsOutput) GoString() string

GoString returns the string representation

func (*DescribeDBEngineVersionsOutput) SetDBEngineVersions Uses

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

SetDBEngineVersions sets the DBEngineVersions field's value.

func (*DescribeDBEngineVersionsOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (DescribeDBEngineVersionsOutput) String Uses

func (s DescribeDBEngineVersionsOutput) String() string

String returns the string representation

type DescribeDBInstancesInput Uses

type DescribeDBInstancesInput struct {

    // The user-provided instance identifier. If this parameter is specified, information
    // from only the specific DB 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 DB instances to describe.
    //
    // Supported filters:
    //
    //    * db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon
    //    Resource Names (ARNs). The results list includes only the information
    //    about the DB instances that are associated with the DB clusters that are
    //    identified by these ARNs.
    //
    //    * db-instance-id - Accepts DB instance identifiers and DB instance ARNs.
    //    The results list includes only the information about the DB 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 Uses

func (s DescribeDBInstancesInput) GoString() string

GoString returns the string representation

func (*DescribeDBInstancesInput) SetDBInstanceIdentifier Uses

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

SetDBInstanceIdentifier sets the DBInstanceIdentifier field's value.

func (*DescribeDBInstancesInput) SetFilters Uses

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

SetFilters sets the Filters field's value.

func (*DescribeDBInstancesInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeDBInstancesInput) SetMaxRecords Uses

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

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBInstancesInput) String Uses

func (s DescribeDBInstancesInput) String() string

String returns the string representation

func (*DescribeDBInstancesInput) Validate Uses

func (s *DescribeDBInstancesInput) Validate() error

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

type DescribeDBInstancesOutput Uses

type DescribeDBInstancesOutput struct {

    // Detailed information about one or more DB 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 Uses

func (s DescribeDBInstancesOutput) GoString() string

GoString returns the string representation

func (*DescribeDBInstancesOutput) SetDBInstances Uses

func (s *DescribeDBInstancesOutput) SetDBInstances(v []*DBInstance) *DescribeDBInstancesOutput

SetDBInstances sets the DBInstances field's value.

func (*DescribeDBInstancesOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (DescribeDBInstancesOutput) String Uses

func (s DescribeDBInstancesOutput) String() string

String returns the string representation

type DescribeDBSubnetGroupsInput Uses

type DescribeDBSubnetGroupsInput struct {

    // The name of the DB 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 Uses

func (s DescribeDBSubnetGroupsInput) GoString() string

GoString returns the string representation

func (*DescribeDBSubnetGroupsInput) SetDBSubnetGroupName Uses

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

SetDBSubnetGroupName sets the DBSubnetGroupName field's value.

func (*DescribeDBSubnetGroupsInput) SetFilters Uses

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

SetFilters sets the Filters field's value.

func (*DescribeDBSubnetGroupsInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeDBSubnetGroupsInput) SetMaxRecords Uses

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

SetMaxRecords sets the MaxRecords field's value.

func (DescribeDBSubnetGroupsInput) String Uses

func (s DescribeDBSubnetGroupsInput) String() string

String returns the string representation

func (*DescribeDBSubnetGroupsInput) Validate Uses

func (s *DescribeDBSubnetGroupsInput) Validate() error

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

type DescribeDBSubnetGroupsOutput Uses

type DescribeDBSubnetGroupsOutput struct {

    // Detailed information about one or more DB 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 Uses

func (s DescribeDBSubnetGroupsOutput) GoString() string

GoString returns the string representation

func (*DescribeDBSubnetGroupsOutput) SetDBSubnetGroups Uses

func (s *DescribeDBSubnetGroupsOutput) SetDBSubnetGroups(v []*DBSubnetGroup) *DescribeDBSubnetGroupsOutput

SetDBSubnetGroups sets the DBSubnetGroups field's value.

func (*DescribeDBSubnetGroupsOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (DescribeDBSubnetGroupsOutput) String Uses

func (s DescribeDBSubnetGroupsOutput) String() string

String returns the string representation

type DescribeEngineDefaultClusterParametersInput Uses

type DescribeEngineDefaultClusterParametersInput struct {

    // The name of the DB 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 Uses

func (s DescribeEngineDefaultClusterParametersInput) GoString() string

GoString returns the string representation

func (*DescribeEngineDefaultClusterParametersInput) SetDBParameterGroupFamily Uses

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

SetDBParameterGroupFamily sets the DBParameterGroupFamily field's value.

func (*DescribeEngineDefaultClusterParametersInput) SetFilters Uses

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

SetFilters sets the Filters field's value.

func (*DescribeEngineDefaultClusterParametersInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeEngineDefaultClusterParametersInput) SetMaxRecords Uses

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

SetMaxRecords sets the MaxRecords field's value.

func (DescribeEngineDefaultClusterParametersInput) String Uses

func (s DescribeEngineDefaultClusterParametersInput) String() string

String returns the string representation

func (*DescribeEngineDefaultClusterParametersInput) Validate Uses

func (s *DescribeEngineDefaultClusterParametersInput) Validate() error

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

type DescribeEngineDefaultClusterParametersOutput Uses

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 Uses

func (s DescribeEngineDefaultClusterParametersOutput) GoString() string

GoString returns the string representation

func (*DescribeEngineDefaultClusterParametersOutput) SetEngineDefaults Uses

func (s *DescribeEngineDefaultClusterParametersOutput) SetEngineDefaults(v *EngineDefaults) *DescribeEngineDefaultClusterParametersOutput

SetEngineDefaults sets the EngineDefaults field's value.

func (DescribeEngineDefaultClusterParametersOutput) String Uses

func (s DescribeEngineDefaultClusterParametersOutput) String() string

String returns the string representation

type DescribeEventCategoriesInput Uses

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, db-snapshot
    SourceType *string `type:"string"`
    // contains filtered or unexported fields
}

Represents the input to DescribeEventCategories.

func (DescribeEventCategoriesInput) GoString Uses

func (s DescribeEventCategoriesInput) GoString() string

GoString returns the string representation

func (*DescribeEventCategoriesInput) SetFilters Uses

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

SetFilters sets the Filters field's value.

func (*DescribeEventCategoriesInput) SetSourceType Uses

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

SetSourceType sets the SourceType field's value.

func (DescribeEventCategoriesInput) String Uses

func (s DescribeEventCategoriesInput) String() string

String returns the string representation

func (*DescribeEventCategoriesInput) Validate Uses

func (s *DescribeEventCategoriesInput) Validate() error

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

type DescribeEventCategoriesOutput Uses

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 Uses

func (s DescribeEventCategoriesOutput) GoString() string

GoString returns the string representation

func (*DescribeEventCategoriesOutput) SetEventCategoriesMapList Uses

func (s *DescribeEventCategoriesOutput) SetEventCategoriesMapList(v []*EventCategoriesMap) *DescribeEventCategoriesOutput

SetEventCategoriesMapList sets the EventCategoriesMapList field's value.

func (DescribeEventCategoriesOutput) String Uses

func (s DescribeEventCategoriesOutput) String() string

String returns the string representation

type DescribeEventsInput Uses

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 Uses

func (s DescribeEventsInput) GoString() string

GoString returns the string representation

func (*DescribeEventsInput) SetDuration Uses

func (s *DescribeEventsInput) SetDuration(v int64) *DescribeEventsInput

SetDuration sets the Duration field's value.

func (*DescribeEventsInput) SetEndTime Uses

func (s *DescribeEventsInput) SetEndTime(v time.Time) *DescribeEventsInput

SetEndTime sets the EndTime field's value.

func (*DescribeEventsInput) SetEventCategories Uses

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

SetEventCategories sets the EventCategories field's value.

func (*DescribeEventsInput) SetFilters Uses

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

SetFilters sets the Filters field's value.

func (*DescribeEventsInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeEventsInput) SetMaxRecords Uses

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

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeEventsInput) SetSourceIdentifier Uses

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

SetSourceIdentifier sets the SourceIdentifier field's value.

func (*DescribeEventsInput) SetSourceType Uses

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

SetSourceType sets the SourceType field's value.

func (*DescribeEventsInput) SetStartTime Uses

func (s *DescribeEventsInput) SetStartTime(v time.Time) *DescribeEventsInput

SetStartTime sets the StartTime field's value.

func (DescribeEventsInput) String Uses

func (s DescribeEventsInput) String() string

String returns the string representation

func (*DescribeEventsInput) Validate Uses

func (s *DescribeEventsInput) Validate() error

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

type DescribeEventsOutput Uses

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 Uses

func (s DescribeEventsOutput) GoString() string

GoString returns the string representation

func (*DescribeEventsOutput) SetEvents Uses

func (s *DescribeEventsOutput) SetEvents(v []*Event) *DescribeEventsOutput

SetEvents sets the Events field's value.

func (*DescribeEventsOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (DescribeEventsOutput) String Uses

func (s DescribeEventsOutput) String() string

String returns the string representation

type DescribeOrderableDBInstanceOptionsInput Uses

type DescribeOrderableDBInstanceOptionsInput struct {

    // The DB instance class filter value. Specify this parameter to show only the
    // available offerings that match the specified DB instance class.
    DBInstanceClass *string `type:"string"`

    // The name of the engine to retrieve DB 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 Uses

func (s DescribeOrderableDBInstanceOptionsInput) GoString() string

GoString returns the string representation

func (*DescribeOrderableDBInstanceOptionsInput) SetDBInstanceClass Uses

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

SetDBInstanceClass sets the DBInstanceClass field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetEngine Uses

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

SetEngine sets the Engine field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetEngineVersion Uses

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

SetEngineVersion sets the EngineVersion field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetFilters Uses

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

SetFilters sets the Filters field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetLicenseModel Uses

func (s *DescribeOrderableDBInstanceOptionsInput) SetLicenseModel(v string) *DescribeOrderableDBInstanceOptionsInput

SetLicenseModel sets the LicenseModel field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetMaxRecords Uses

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

SetMaxRecords sets the MaxRecords field's value.

func (*DescribeOrderableDBInstanceOptionsInput) SetVpc Uses

func (s *DescribeOrderableDBInstanceOptionsInput) SetVpc(v bool) *DescribeOrderableDBInstanceOptionsInput

SetVpc sets the Vpc field's value.

func (DescribeOrderableDBInstanceOptionsInput) String Uses

func (s DescribeOrderableDBInstanceOptionsInput) String() string

String returns the string representation

func (*DescribeOrderableDBInstanceOptionsInput) Validate Uses

func (s *DescribeOrderableDBInstanceOptionsInput) Validate() error

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

type DescribeOrderableDBInstanceOptionsOutput Uses

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 DB instance.
    OrderableDBInstanceOptions []*OrderableDBInstanceOption `locationNameList:"OrderableDBInstanceOption" type:"list"`
    // contains filtered or unexported fields
}

Represents the output of DescribeOrderableDBInstanceOptions.

func (DescribeOrderableDBInstanceOptionsOutput) GoString Uses

func (s DescribeOrderableDBInstanceOptionsOutput) GoString() string

GoString returns the string representation

func (*DescribeOrderableDBInstanceOptionsOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribeOrderableDBInstanceOptionsOutput) SetOrderableDBInstanceOptions Uses

func (s *DescribeOrderableDBInstanceOptionsOutput) SetOrderableDBInstanceOptions(v []*OrderableDBInstanceOption) *DescribeOrderableDBInstanceOptionsOutput

SetOrderableDBInstanceOptions sets the OrderableDBInstanceOptions field's value.

func (DescribeOrderableDBInstanceOptionsOutput) String Uses

func (s DescribeOrderableDBInstanceOptionsOutput) String() string

String returns the string representation

type DescribePendingMaintenanceActionsInput Uses

type DescribePendingMaintenanceActionsInput struct {

    // A filter that specifies one or more resources to return pending maintenance
    // actions for.
    //
    // Supported filters:
    //
    //    * db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon
    //    Resource Names (ARNs). The results list includes only pending maintenance
    //    actions for the DB clusters identified by these ARNs.
    //
    //    * db-instance-id - Accepts DB instance identifiers and DB 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 Uses

func (s DescribePendingMaintenanceActionsInput) GoString() string

GoString returns the string representation

func (*DescribePendingMaintenanceActionsInput) SetFilters Uses

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

SetFilters sets the Filters field's value.

func (*DescribePendingMaintenanceActionsInput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribePendingMaintenanceActionsInput) SetMaxRecords Uses

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

SetMaxRecords sets the MaxRecords field's value.

func (*DescribePendingMaintenanceActionsInput) SetResourceIdentifier Uses

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

SetResourceIdentifier sets the ResourceIdentifier field's value.

func (DescribePendingMaintenanceActionsInput) String Uses

func (s DescribePendingMaintenanceActionsInput) String() string

String returns the string representation

func (*DescribePendingMaintenanceActionsInput) Validate Uses

func (s *DescribePendingMaintenanceActionsInput) Validate() error

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

type DescribePendingMaintenanceActionsOutput Uses

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 Uses

func (s DescribePendingMaintenanceActionsOutput) GoString() string

GoString returns the string representation

func (*DescribePendingMaintenanceActionsOutput) SetMarker Uses

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

SetMarker sets the Marker field's value.

func (*DescribePendingMaintenanceActionsOutput) SetPendingMaintenanceActions Uses

func (s *DescribePendingMaintenanceActionsOutput) SetPendingMaintenanceActions(v []*ResourcePendingMaintenanceActions) *DescribePendingMaintenanceActionsOutput

SetPendingMaintenanceActions sets the PendingMaintenanceActions field's value.

func (DescribePendingMaintenanceActionsOutput) String Uses

func (s DescribePendingMaintenanceActionsOutput) String() string

String returns the string representation

type DocDB Uses

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 Uses

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:

// 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) AddTagsToResource Uses

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 AWS 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 DB instance.

* ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound"
DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

* ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault"
DBClusterIdentifier doesn't refer to an existing DB cluster.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/AddTagsToResource

func (*DocDB) AddTagsToResourceRequest Uses

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 Uses

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 Uses

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 a DB 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 DB cluster isn't in a valid state.

* ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState"
The specified DB instance isn't in the available state.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ApplyPendingMaintenanceAction

func (*DocDB) ApplyPendingMaintenanceActionRequest Uses

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 Uses

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 Uses

func (c *DocDB) CopyDBClusterParameterGroup(input *CopyDBClusterParameterGroupInput) (*CopyDBClusterParameterGroupOutput, error)

CopyDBClusterParameterGroup API operation for Amazon DocumentDB with MongoDB compatibility.

Copies the specified DB 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 DB parameter group.

* ErrCodeDBParameterGroupQuotaExceededFault "DBParameterGroupQuotaExceeded"
This request would cause you to exceed the allowed number of DB parameter
groups.

* ErrCodeDBParameterGroupAlreadyExistsFault "DBParameterGroupAlreadyExists"
A DB 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 Uses

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 Uses

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 Uses

func (c *DocDB) CopyDBClusterSnapshot(input *CopyDBClusterSnapshotInput) (*CopyDBClusterSnapshotOutput, error)

CopyDBClusterSnapshot API operation for Amazon DocumentDB with MongoDB compatibility.

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

To cancel the copy operation after it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB 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 DB cluster snapshot with the given identifier.

* ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault"
DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

* ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault"
The DB cluster isn't in a valid state.

* ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault"
The provided value isn't a valid DB cluster snapshot state.

* ErrCodeSnapshotQuotaExceededFault "SnapshotQuotaExceeded"
The request would cause you to exceed the allowed number of DB snapshots.

* ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault"
An error occurred when accessing an AWS KMS key.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterSnapshot

func (*DocDB) CopyDBClusterSnapshotRequest Uses

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 Uses

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 Uses

func (c *DocDB) CreateDBCluster(input *CreateDBClusterInput) (*CreateDBClusterOutput, error)

CreateDBCluster API operation for Amazon DocumentDB with MongoDB compatibility.

Creates a new Amazon DocumentDB DB 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 DB 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 DB cluster can't be created because you have reached the maximum allowed
quota of DB clusters.

* ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded"
The request would cause you to exceed the allowed amount of storage available
across all DB instances.

* ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault"
DBSubnetGroupName doesn't refer to an existing DB subnet group.

* ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault"
The DB subnet group doesn't cover all Availability Zones after it is created
because of changes that were made.

* ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault"
The DB cluster isn't in a valid state.

* ErrCodeInvalidDBSubnetGroupStateFault "InvalidDBSubnetGroupStateFault"
The DB 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 DB instance isn't in the available state.

* ErrCodeDBClusterParameterGroupNotFoundFault "DBClusterParameterGroupNotFound"
DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter
group.

* ErrCodeKMSKeyNotAccessibleFault "KMSKeyNotAccessibleFault"
An error occurred when accessing an AWS KMS key.

* ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault"
DBClusterIdentifier doesn't refer to an existing DB cluster.

* ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound"
DBInstanceIdentifier doesn't refer to an existing DB instance.

* ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs "DBSubnetGroupDoesNotCoverEnoughAZs"
Subnets in the DB subnet group should cover at least two Availability Zones
unless there is only one Availability Zone.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBCluster

func (*DocDB) CreateDBClusterParameterGroup Uses

func (c *DocDB) CreateDBClusterParameterGroup(input *CreateDBClusterParameterGroupInput) (*CreateDBClusterParameterGroupOutput, error)

CreateDBClusterParameterGroup API operation for Amazon DocumentDB with MongoDB compatibility.

Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your DB cluster. For the new DB cluster parameter group and associated settings to take effect, you must then reboot the DB instances in the DB cluster without failover.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This step is especially important for parameters that are critical when creating the default database for a DB 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 CreateDBClusterParameterGroup for usage and error information.

Returned Error Codes:

* ErrCodeDBParameterGroupQuotaExceededFault "DBParameterGroupQuotaExceeded"
This request would cause you to exceed the allowed number of DB parameter
groups.

* ErrCodeDBParameterGroupAlreadyExistsFault "DBParameterGroupAlreadyExists"
A DB 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 Uses

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 Uses

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 Uses

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 Uses

func (c *DocDB) CreateDBClusterSnapshot(input *CreateDBClusterSnapshotInput) (*CreateDBClusterSnapshotOutput, error)

CreateDBClusterSnapshot API operation for Amazon DocumentDB with MongoDB compatibility.

Creates a snapshot of a DB 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 DB cluster snapshot with the given identifier.

* ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault"
The DB cluster isn't in a valid state.

* ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault"
DBClusterIdentifier doesn't refer to an existing DB cluster.

* ErrCodeSnapshotQuotaExceededFault "SnapshotQuotaExceeded"
The request would cause you to exceed the allowed number of DB snapshots.

* ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault"
The provided value isn't a valid DB cluster snapshot state.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterSnapshot

func (*DocDB) CreateDBClusterSnapshotRequest Uses

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 Uses

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 Uses

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 Uses

func (c *DocDB) CreateDBInstance(input *CreateDBInstanceInput) (*CreateDBInstanceOutput, error)

CreateDBInstance API operation for Amazon DocumentDB with MongoDB compatibility.

Creates a new DB 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 DB instance with the given identifier.

* ErrCodeInsufficientDBInstanceCapacityFault "InsufficientDBInstanceCapacity"
The specified DB instance class isn't available in the specified Availability
Zone.

* ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound"
DBParameterGroupName doesn't refer to an existing DB parameter group.

* ErrCodeDBSecurityGroupNotFoundFault "DBSecurityGroupNotFound"
DBSecurityGroupName doesn't refer to an existing DB security group.

* ErrCodeInstanceQuotaExceededFault "InstanceQuotaExceeded"
The request would cause you to exceed the allowed number of DB instances.

* ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded"
The request would cause you to exceed the allowed amount of storage available
across all DB instances.

* ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault"
DBSubnetGroupName doesn't refer to an existing DB subnet group.

* ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs "DBSubnetGroupDoesNotCoverEnoughAZs"
Subnets in the DB subnet group should cover at least two Availability Zones
unless there is only one Availability Zone.

* ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault"
The DB 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 DB 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 DB 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 DB 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 AWS KMS key.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBInstance

func (*DocDB) CreateDBInstanceRequest Uses

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 Uses

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 Uses

func (c *DocDB) CreateDBSubnetGroup(input *CreateDBSubnetGroupInput) (*CreateDBSubnetGroupOutput, error)

CreateDBSubnetGroup API operation for Amazon DocumentDB with MongoDB compatibility.

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS 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 DB subnet group.

* ErrCodeDBSubnetGroupQuotaExceededFault "DBSubnetGroupQuotaExceeded"
The request would cause you to exceed the allowed number of DB subnet groups.

* ErrCodeDBSubnetQuotaExceededFault "DBSubnetQuotaExceededFault"
The request would cause you to exceed the allowed number of subnets in a
DB subnet group.

* ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs "DBSubnetGroupDoesNotCoverEnoughAZs"
Subnets in the DB 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 Uses

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 Uses

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) DeleteDBCluster Uses

func (c *DocDB) DeleteDBCluster(input *DeleteDBClusterInput) (*DeleteDBClusterOutput, error)

DeleteDBCluster API operation for Amazon DocumentDB with MongoDB compatibility.

Deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB 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 DB cluster.

* ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault"
The DB cluster isn't in a valid state.

* ErrCodeDBClusterSnapshotAlreadyExistsFault "DBClusterSnapshotAlreadyExistsFault"
You already have a DB cluster snapshot with the given identifier.

* ErrCodeSnapshotQuotaExceededFault "SnapshotQuotaExceeded"
The request would cause you to exceed the allowed number of DB snapshots.

* ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault"
The provided value isn't a valid DB cluster snapshot state.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBCluster

func (*DocDB) DeleteDBClusterParameterGroup Uses

func (c *DocDB) DeleteDBClusterParameterGroup(input *DeleteDBClusterParameterGroupInput) (*DeleteDBClusterParameterGroupOutput, error)

DeleteDBClusterParameterGroup API operation for Amazon DocumentDB with MongoDB compatibility.

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB 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 DB 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 DB parameter group.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterParameterGroup

func (*DocDB) DeleteDBClusterParameterGroupRequest Uses

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 Uses

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 Uses

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 Uses

func (c *DocDB) DeleteDBClusterSnapshot(input *DeleteDBClusterSnapshotInput) (*DeleteDBClusterSnapshotOutput, error)

DeleteDBClusterSnapshot API operation for Amazon DocumentDB with MongoDB compatibility.

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB 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 DB cluster snapshot state.

* ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault"
DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterSnapshot

func (*DocDB) DeleteDBClusterSnapshotRequest Uses

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 Uses

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 Uses

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 Uses

func (c *DocDB) DeleteDBInstance(input *DeleteDBInstanceInput) (*DeleteDBInstanceOutput, error)

DeleteDBInstance API operation for Amazon DocumentDB with MongoDB compatibility.

Deletes a previously provisioned DB 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 DB instance.

* ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState"
The specified DB 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 DB snapshots.

* ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault"
The DB cluster isn't in a valid state.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBInstance

func (*DocDB) DeleteDBInstanceRequest Uses

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 Uses

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 Uses

func (c *DocDB) DeleteDBSubnetGroup(input *DeleteDBSubnetGroupInput) (*DeleteDBSubnetGroupOutput, error)

DeleteDBSubnetGroup API operation for Amazon DocumentDB with MongoDB compatibility.

Deletes a DB 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 DB subnet group can't be deleted because it's in use.

* ErrCodeInvalidDBSubnetStateFault "InvalidDBSubnetStateFault"
The DB subnet isn't in the available state.

* ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault"
DBSubnetGroupName doesn't refer to an existing DB subnet group.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBSubnetGroup

func (*DocDB) DeleteDBSubnetGroupRequest Uses

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 Uses

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) DescribeDBClusterParameterGroups Uses

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 DB 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 DB parameter group.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterParameterGroups

func (*DocDB) DescribeDBClusterParameterGroupsRequest Uses

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 Uses

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 Uses

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 DB 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 DB parameter group.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterParameters

func (*DocDB) DescribeDBClusterParametersRequest Uses

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 Uses

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 Uses

func (c *DocDB) DescribeDBClusterSnapshotAttributes(input *DescribeDBClusterSnapshotAttributesInput) (*DescribeDBClusterSnapshotAttributesOutput, error)

DescribeDBClusterSnapshotAttributes API operation for Amazon DocumentDB with MongoDB compatibility.

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

When you share snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS 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 DB cluster snapshot.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshotAttributes

func (*DocDB) DescribeDBClusterSnapshotAttributesRequest Uses

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 Uses

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 Uses

func (c *DocDB) DescribeDBClusterSnapshots(input *DescribeDBClusterSnapshotsInput) (*DescribeDBClusterSnapshotsOutput, error)

DescribeDBClusterSnapshots API operation for Amazon DocumentDB with MongoDB compatibility.

Returns information about DB 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 DB cluster snapshot.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshots

func (*DocDB) DescribeDBClusterSnapshotsRequest Uses

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 Uses

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 Uses

func (c *DocDB) DescribeDBClusters(input *DescribeDBClustersInput) (*DescribeDBClustersOutput, error)

DescribeDBClusters API operation for Amazon DocumentDB with MongoDB compatibility.

Returns information about provisioned Amazon DocumentDB DB clusters. 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 DescribeDBClusters for usage and error information.

Returned Error Codes:

* ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault"
DBClusterIdentifier doesn't refer to an existing DB cluster.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusters

func (*DocDB) DescribeDBClustersPages Uses

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 Uses

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 Uses

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 Uses

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 Uses

func (c *DocDB) DescribeDBEngineVersions(input *DescribeDBEngineVersionsInput) (*DescribeDBEngineVersionsOutput, error)

DescribeDBEngineVersions API operation for Amazon DocumentDB with MongoDB compatibility.

Returns a list of the available DB 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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 DB instance.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBInstances

func (*DocDB) DescribeDBInstancesPages Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 DB subnet group.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBSubnetGroups

func (*DocDB) DescribeDBSubnetGroupsPages Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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) DescribeEvents Uses

func (c *DocDB) DescribeEvents(input *DescribeEventsInput) (*DescribeEventsOutput, error)

DescribeEvents API operation for Amazon DocumentDB with MongoDB compatibility.

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, DB security group, DB snapshot, or DB 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 Uses

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 Uses

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 Uses

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 Uses

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) DescribeOrderableDBInstanceOptions Uses

func (c *DocDB) DescribeOrderableDBInstanceOptions(input *DescribeOrderableDBInstanceOptionsInput) (*DescribeOrderableDBInstanceOptionsOutput, error)

DescribeOrderableDBInstanceOptions API operation for Amazon DocumentDB with MongoDB compatibility.

Returns a list of orderable DB 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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

func (c *DocDB) DescribePendingMaintenanceActions(input *DescribePendingMaintenanceActionsInput) (*DescribePendingMaintenanceActionsOutput, error)

DescribePendingMaintenanceActions API operation for Amazon DocumentDB with MongoDB compatibility.

Returns a list of resources (for example, DB 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) DescribePendingMaintenanceActionsRequest Uses

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 Uses

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 Uses

func (c *DocDB) FailoverDBCluster(input *FailoverDBClusterInput) (*FailoverDBClusterOutput, error)

FailoverDBCluster API operation for Amazon DocumentDB with MongoDB compatibility.

Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the DB 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 DB cluster.

* ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault"
The DB cluster isn't in a valid state.

* ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState"
The specified DB instance isn't in the available state.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/FailoverDBCluster

func (*DocDB) FailoverDBClusterRequest Uses

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 Uses

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 Uses

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 DB instance.

* ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound"
DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

* ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault"
DBClusterIdentifier doesn't refer to an existing DB cluster.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ListTagsForResource

func (*DocDB) ListTagsForResourceRequest Uses

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 Uses

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 Uses

func (c *DocDB) ModifyDBCluster(input *ModifyDBClusterInput) (*ModifyDBClusterOutput, error)

ModifyDBCluster API operation for Amazon DocumentDB with MongoDB compatibility.

Modifies a setting for an Amazon DocumentDB DB 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 DB cluster.

* ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault"
The DB cluster isn't in a valid state.

* ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded"
The request would cause you to exceed the allowed amount of storage available
across all DB instances.

* ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault"
DBSubnetGroupName doesn't refer to an existing DB subnet group.

* ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault"
The DB subnet group doesn't cover all Availability Zones after it is created
because of changes that were made.

* ErrCodeInvalidDBSubnetGroupStateFault "InvalidDBSubnetGroupStateFault"
The DB 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 DB cluster parameter
group.

* ErrCodeInvalidDBSecurityGroupStateFault "InvalidDBSecurityGroupState"
The state of the DB security group doesn't allow deletion.

* ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState"
The specified DB instance isn't in the available state.

* ErrCodeDBClusterAlreadyExistsFault "DBClusterAlreadyExistsFault"
You already have a DB cluster with the given identifier.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBCluster

func (*DocDB) ModifyDBClusterParameterGroup Uses

func (c *DocDB) ModifyDBClusterParameterGroup(input *ModifyDBClusterParameterGroupInput) (*ModifyDBClusterParameterGroupOutput, error)

ModifyDBClusterParameterGroup API operation for Amazon DocumentDB with MongoDB compatibility.

Modifies the parameters of a DB 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 DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB 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 DB cluster. This step is especially important for parameters that are critical when creating the default database for a DB 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 DB parameter group.

* ErrCodeInvalidDBParameterGroupStateFault "InvalidDBParameterGroupState"
The DB 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 Uses

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 Uses

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 Uses

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 Uses

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 DB cluster snapshot.

To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS 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 DB cluster snapshot.

* ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault"
The provided value isn't a valid DB 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 Uses

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 Uses

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 Uses

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 Uses

func (c *DocDB) ModifyDBInstance(input *ModifyDBInstanceInput) (*ModifyDBInstanceOutput, error)

ModifyDBInstance API operation for Amazon DocumentDB with MongoDB compatibility.

Modifies settings for a DB 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 DB instance isn't in the available state.

* ErrCodeInvalidDBSecurityGroupStateFault "InvalidDBSecurityGroupState"
The state of the DB security group doesn't allow deletion.

* ErrCodeDBInstanceAlreadyExistsFault "DBInstanceAlreadyExists"
You already have a DB instance with the given identifier.

* ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound"
DBInstanceIdentifier doesn't refer to an existing DB instance.

* ErrCodeDBSecurityGroupNotFoundFault "DBSecurityGroupNotFound"
DBSecurityGroupName doesn't refer to an existing DB security group.

* ErrCodeDBParameterGroupNotFoundFault "DBParameterGroupNotFound"
DBParameterGroupName doesn't refer to an existing DB parameter group.

* ErrCodeInsufficientDBInstanceCapacityFault "InsufficientDBInstanceCapacity"
The specified DB 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 DB instances.

* ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault"
The DB subnet group doesn't cover all Availability Zones after it is created
because of changes that were made.

* ErrCodeDBUpgradeDependencyFailureFault "DBUpgradeDependencyFailure"
The DB upgrade failed because a resource that the DB 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 DB 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 Uses

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 Uses

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 Uses

func (c *DocDB) ModifyDBSubnetGroup(input *ModifyDBSubnetGroupInput) (*ModifyDBSubnetGroupOutput, error)

ModifyDBSubnetGroup API operation for Amazon DocumentDB with MongoDB compatibility.

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS 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 DB subnet group.

* ErrCodeDBSubnetQuotaExceededFault "DBSubnetQuotaExceededFault"
The request would cause you to exceed the allowed number of subnets in a
DB subnet group.

* ErrCodeSubnetAlreadyInUse "SubnetAlreadyInUse"
The DB subnet is already in use in the Availability Zone.

* ErrCodeDBSubnetGroupDoesNotCoverEnoughAZs "DBSubnetGroupDoesNotCoverEnoughAZs"
Subnets in the DB 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 Uses

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 Uses

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) RebootDBInstance Uses

func (c *DocDB) RebootDBInstance(input *RebootDBInstanceInput) (*RebootDBInstanceOutput, error)

RebootDBInstance API operation for Amazon DocumentDB with MongoDB compatibility.

You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the DB cluster parameter group that is associated with the DB instance, you must reboot the instance for the changes to take effect.

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB 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 DB instance isn't in the available state.

* ErrCodeDBInstanceNotFoundFault "DBInstanceNotFound"
DBInstanceIdentifier doesn't refer to an existing DB instance.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RebootDBInstance

func (*DocDB) RebootDBInstanceRequest Uses

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 Uses

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) RemoveTagsFromResource Uses

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 DB instance.

* ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound"
DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

* ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault"
DBClusterIdentifier doesn't refer to an existing DB cluster.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveTagsFromResource

func (*DocDB) RemoveTagsFromResourceRequest Uses

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 Uses

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 Uses

func (c *DocDB) ResetDBClusterParameterGroup(input *ResetDBClusterParameterGroupInput) (*ResetDBClusterParameterGroupOutput, error)

ResetDBClusterParameterGroup API operation for Amazon DocumentDB with MongoDB compatibility.

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB 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 DB 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 DB parameter group.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ResetDBClusterParameterGroup

func (*DocDB) ResetDBClusterParameterGroupRequest Uses

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 Uses

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 Uses

func (c *DocDB) RestoreDBClusterFromSnapshot(input *RestoreDBClusterFromSnapshotInput) (*RestoreDBClusterFromSnapshotOutput, error)

RestoreDBClusterFromSnapshot API operation for Amazon DocumentDB with MongoDB compatibility.

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB 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 DB cluster with the given identifier.

* ErrCodeDBClusterQuotaExceededFault "DBClusterQuotaExceededFault"
The DB cluster can't be created because you have reached the maximum allowed
quota of DB clusters.

* ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded"
The request would cause you to exceed the allowed amount of storage available
across all DB instances.

* ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault"
DBSubnetGroupName doesn't refer to an existing DB subnet group.

* ErrCodeDBSnapshotNotFoundFault "DBSnapshotNotFound"
DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

* ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault"
DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

* ErrCodeInsufficientDBClusterCapacityFault "InsufficientDBClusterCapacityFault"
The DB 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 DB snapshot doesn't allow deletion.

* ErrCodeInvalidDBClusterSnapshotStateFault "InvalidDBClusterSnapshotStateFault"
The provided value isn't a valid DB cluster snapshot state.

* ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded"
The request would cause you to exceed the allowed amount of storage available
across all DB instances.

* ErrCodeInvalidVPCNetworkStateFault "InvalidVPCNetworkStateFault"
The DB 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 DB 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 AWS KMS key.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterFromSnapshot

func (*DocDB) RestoreDBClusterFromSnapshotRequest Uses

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 Uses

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 Uses

func (c *DocDB) RestoreDBClusterToPointInTime(input *RestoreDBClusterToPointInTimeInput) (*RestoreDBClusterToPointInTimeOutput, error)

RestoreDBClusterToPointInTime API operation for Amazon DocumentDB with MongoDB compatibility.

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB 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 DB cluster with the given identifier.

* ErrCodeDBClusterNotFoundFault "DBClusterNotFoundFault"
DBClusterIdentifier doesn't refer to an existing DB cluster.

* ErrCodeDBClusterQuotaExceededFault "DBClusterQuotaExceededFault"
The DB cluster can't be created because you have reached the maximum allowed
quota of DB clusters.

* ErrCodeDBClusterSnapshotNotFoundFault "DBClusterSnapshotNotFoundFault"
DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

* ErrCodeDBSubnetGroupNotFoundFault "DBSubnetGroupNotFoundFault"
DBSubnetGroupName doesn't refer to an existing DB subnet group.

* ErrCodeInsufficientDBClusterCapacityFault "InsufficientDBClusterCapacityFault"
The DB 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 DB cluster snapshot state.

* ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault"
The DB cluster isn't in a valid state.

* ErrCodeInvalidDBSnapshotStateFault "InvalidDBSnapshotState"
The state of the DB 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 DB 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 AWS KMS key.

* ErrCodeStorageQuotaExceededFault "StorageQuotaExceeded"
The request would cause you to exceed the allowed amount of storage available
across all DB instances.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterToPointInTime

func (*DocDB) RestoreDBClusterToPointInTimeRequest Uses

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 Uses

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 Uses

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 DB cluster.

* ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault"
The DB cluster isn't in a valid state.

* ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState"
The specified DB instance isn't in the available state.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/StartDBCluster

func (*DocDB) StartDBClusterRequest Uses

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 Uses

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 Uses

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 DB cluster.

* ErrCodeInvalidDBClusterStateFault "InvalidDBClusterStateFault"
The DB cluster isn't in a valid state.

* ErrCodeInvalidDBInstanceStateFault "InvalidDBInstanceState"
The specified DB instance isn't in the available state.

See also, https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/StopDBCluster

func (*DocDB) StopDBClusterRequest Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

type Endpoint struct {

    // Specifies the DNS address of the DB 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 DB cluster or DB instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.

func (Endpoint) GoString Uses

func (s Endpoint) GoString() string

GoString returns the string representation

func (*Endpoint) SetAddress Uses

func (s *Endpoint) SetAddress(v string) *Endpoint

SetAddress sets the Address field's value.

func (*Endpoint) SetHostedZoneId Uses

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

SetHostedZoneId sets the HostedZoneId field's value.

func (*Endpoint) SetPort Uses

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

SetPort sets the Port field's value.

func (Endpoint) String Uses

func (s Endpoint) String() string

String returns the string representation

type EngineDefaults Uses

type EngineDefaults struct {

    // The name of the DB 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 DB cluster parameter group f