docdb

package
v0.9.0 Latest Latest
Warning

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

 Go to latest Published: May 28, 2019 License: Apache-2.0 Imports: 8 Imported by: 30

Documentation

Overview

Package docdb provides the client and types for making API requests to Amazon DocDB.

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

Index

Constants

View Source 
const (
	ServiceName = "Amazon DocDB" // Service's name
	ServiceID   = "DocDB"        // Service's identifier
	EndpointsID = "rds"          // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeAuthorizationNotFoundFault for service response error code
	// "AuthorizationNotFound".
	//
	// The specified CIDR IP or Amazon EC2 security group isn't authorized for the
	// specified 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"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AddTagsToResourceInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/AddTagsToResourceMessage

func (AddTagsToResourceInput) String 

func (s AddTagsToResourceInput) String() string

String returns the string representation

func (*AddTagsToResourceInput) Validate 

func (s *AddTagsToResourceInput) Validate() error

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

type AddTagsToResourceOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/AddTagsToResourceOutput

func (AddTagsToResourceOutput) String 

func (s AddTagsToResourceOutput) String() string

String returns the string representation

type AddTagsToResourceRequest 

type AddTagsToResourceRequest struct {
	*aws.Request
	Input *AddTagsToResourceInput
	Copy  func(*AddTagsToResourceInput) AddTagsToResourceRequest
}

AddTagsToResourceRequest is the request type for the AddTagsToResource API operation.

func (AddTagsToResourceRequest) Send 

func (r AddTagsToResourceRequest) Send(ctx context.Context) (*AddTagsToResourceResponse, error)

Send marshals and sends the AddTagsToResource API request.

type AddTagsToResourceResponse added in v0.9.0 

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

AddTagsToResourceResponse is the response type for the AddTagsToResource API operation.

func (*AddTagsToResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *AddTagsToResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AddTagsToResource request.

type ApplyMethod 

type ApplyMethod string
const (
	ApplyMethodImmediate     ApplyMethod = "immediate"
	ApplyMethodPendingReboot ApplyMethod = "pending-reboot"
)

Enum values for ApplyMethod

func (ApplyMethod) MarshalValue 

func (enum ApplyMethod) MarshalValue() (string, error)

func (ApplyMethod) MarshalValueBuf 

func (enum ApplyMethod) MarshalValueBuf(b []byte) ([]byte, error)

type ApplyPendingMaintenanceActionInput 

type ApplyPendingMaintenanceActionInput struct {

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

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

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

Represents the input to ApplyPendingMaintenanceAction. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ApplyPendingMaintenanceActionMessage

func (ApplyPendingMaintenanceActionInput) String 

func (s ApplyPendingMaintenanceActionInput) String() string

String returns the string representation

func (*ApplyPendingMaintenanceActionInput) Validate 

func (s *ApplyPendingMaintenanceActionInput) Validate() error

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

type ApplyPendingMaintenanceActionOutput 

type ApplyPendingMaintenanceActionOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ApplyPendingMaintenanceActionResult

func (ApplyPendingMaintenanceActionOutput) String 

func (s ApplyPendingMaintenanceActionOutput) String() string

String returns the string representation

type ApplyPendingMaintenanceActionRequest 

type ApplyPendingMaintenanceActionRequest struct {
	*aws.Request
	Input *ApplyPendingMaintenanceActionInput
	Copy  func(*ApplyPendingMaintenanceActionInput) ApplyPendingMaintenanceActionRequest
}

ApplyPendingMaintenanceActionRequest is the request type for the ApplyPendingMaintenanceAction API operation.

func (ApplyPendingMaintenanceActionRequest) Send 

func (r ApplyPendingMaintenanceActionRequest) Send(ctx context.Context) (*ApplyPendingMaintenanceActionResponse, error)

Send marshals and sends the ApplyPendingMaintenanceAction API request.

type ApplyPendingMaintenanceActionResponse added in v0.9.0 

type ApplyPendingMaintenanceActionResponse struct {
	*ApplyPendingMaintenanceActionOutput
	// contains filtered or unexported fields
}

ApplyPendingMaintenanceActionResponse is the response type for the ApplyPendingMaintenanceAction API operation.

func (*ApplyPendingMaintenanceActionResponse) SDKResponseMetdata added in v0.9.0 

func (r *ApplyPendingMaintenanceActionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ApplyPendingMaintenanceAction request.

type AvailabilityZone 

type AvailabilityZone struct {

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

Information about an Availability Zone. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/AvailabilityZone

func (AvailabilityZone) String 

func (s AvailabilityZone) String() string

String returns the string representation

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to Amazon DocDB. See this package's package overview docs for details on the service.

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

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := docdb.New(myConfig)

func (*Client) AddTagsToResourceRequest added in v0.9.0 

func (c *Client) AddTagsToResourceRequest(input *AddTagsToResourceInput) AddTagsToResourceRequest

AddTagsToResourceRequest returns a request value for making 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. 

// Example sending a request using AddTagsToResourceRequest.
req := client.AddTagsToResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ApplyPendingMaintenanceActionRequest added in v0.9.0 

func (c *Client) ApplyPendingMaintenanceActionRequest(input *ApplyPendingMaintenanceActionInput) ApplyPendingMaintenanceActionRequest

ApplyPendingMaintenanceActionRequest returns a request value for making API operation for Amazon DocumentDB with MongoDB compatibility.

Applies a pending maintenance action to a resource (for example, to a DB instance). 

// Example sending a request using ApplyPendingMaintenanceActionRequest.
req := client.ApplyPendingMaintenanceActionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) CopyDBClusterParameterGroupRequest added in v0.9.0 

func (c *Client) CopyDBClusterParameterGroupRequest(input *CopyDBClusterParameterGroupInput) CopyDBClusterParameterGroupRequest

CopyDBClusterParameterGroupRequest returns a request value for making API operation for Amazon DocumentDB with MongoDB compatibility.

Copies the specified DB cluster parameter group. 

// Example sending a request using CopyDBClusterParameterGroupRequest.
req := client.CopyDBClusterParameterGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterParameterGroup

func (*Client) CopyDBClusterSnapshotRequest added in v0.9.0 

func (c *Client) CopyDBClusterSnapshotRequest(input *CopyDBClusterSnapshotInput) CopyDBClusterSnapshotRequest

CopyDBClusterSnapshotRequest returns a request value for making 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. 

// Example sending a request using CopyDBClusterSnapshotRequest.
req := client.CopyDBClusterSnapshotRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) CreateDBClusterParameterGroupRequest added in v0.9.0 

func (c *Client) CreateDBClusterParameterGroupRequest(input *CreateDBClusterParameterGroupInput) CreateDBClusterParameterGroupRequest

CreateDBClusterParameterGroupRequest returns a request value for making 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. 

// Example sending a request using CreateDBClusterParameterGroupRequest.
req := client.CreateDBClusterParameterGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterParameterGroup

func (*Client) CreateDBClusterRequest added in v0.9.0 

func (c *Client) CreateDBClusterRequest(input *CreateDBClusterInput) CreateDBClusterRequest

CreateDBClusterRequest returns a request value for making API operation for Amazon DocumentDB with MongoDB compatibility.

Creates a new Amazon DocumentDB DB cluster. 

// Example sending a request using CreateDBClusterRequest.
req := client.CreateDBClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) CreateDBClusterSnapshotRequest added in v0.9.0 

func (c *Client) CreateDBClusterSnapshotRequest(input *CreateDBClusterSnapshotInput) CreateDBClusterSnapshotRequest

CreateDBClusterSnapshotRequest returns a request value for making API operation for Amazon DocumentDB with MongoDB compatibility.

Creates a snapshot of a DB cluster. 

// Example sending a request using CreateDBClusterSnapshotRequest.
req := client.CreateDBClusterSnapshotRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) CreateDBInstanceRequest added in v0.9.0 

func (c *Client) CreateDBInstanceRequest(input *CreateDBInstanceInput) CreateDBInstanceRequest

CreateDBInstanceRequest returns a request value for making API operation for Amazon DocumentDB with MongoDB compatibility.

Creates a new DB instance. 

// Example sending a request using CreateDBInstanceRequest.
req := client.CreateDBInstanceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) CreateDBSubnetGroupRequest added in v0.9.0 

func (c *Client) CreateDBSubnetGroupRequest(input *CreateDBSubnetGroupInput) CreateDBSubnetGroupRequest

CreateDBSubnetGroupRequest returns a request value for making 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. 

// Example sending a request using CreateDBSubnetGroupRequest.
req := client.CreateDBSubnetGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBSubnetGroup

func (*Client) DeleteDBClusterParameterGroupRequest added in v0.9.0 

func (c *Client) DeleteDBClusterParameterGroupRequest(input *DeleteDBClusterParameterGroupInput) DeleteDBClusterParameterGroupRequest

DeleteDBClusterParameterGroupRequest returns a request value for making 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. 

// Example sending a request using DeleteDBClusterParameterGroupRequest.
req := client.DeleteDBClusterParameterGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteDBClusterRequest added in v0.9.0 

func (c *Client) DeleteDBClusterRequest(input *DeleteDBClusterInput) DeleteDBClusterRequest

DeleteDBClusterRequest returns a request value for making 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. 

// Example sending a request using DeleteDBClusterRequest.
req := client.DeleteDBClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteDBClusterSnapshotRequest added in v0.9.0 

func (c *Client) DeleteDBClusterSnapshotRequest(input *DeleteDBClusterSnapshotInput) DeleteDBClusterSnapshotRequest

DeleteDBClusterSnapshotRequest returns a request value for making 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. 

// Example sending a request using DeleteDBClusterSnapshotRequest.
req := client.DeleteDBClusterSnapshotRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteDBInstanceRequest added in v0.9.0 

func (c *Client) DeleteDBInstanceRequest(input *DeleteDBInstanceInput) DeleteDBInstanceRequest

DeleteDBInstanceRequest returns a request value for making API operation for Amazon DocumentDB with MongoDB compatibility.

Deletes a previously provisioned DB instance. 

// Example sending a request using DeleteDBInstanceRequest.
req := client.DeleteDBInstanceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DeleteDBSubnetGroupRequest added in v0.9.0 

func (c *Client) DeleteDBSubnetGroupRequest(input *DeleteDBSubnetGroupInput) DeleteDBSubnetGroupRequest

DeleteDBSubnetGroupRequest returns a request value for making 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. 

// Example sending a request using DeleteDBSubnetGroupRequest.
req := client.DeleteDBSubnetGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeDBClusterParameterGroupsRequest added in v0.9.0 

func (c *Client) DescribeDBClusterParameterGroupsRequest(input *DescribeDBClusterParameterGroupsInput) DescribeDBClusterParameterGroupsRequest

DescribeDBClusterParameterGroupsRequest returns a request value for making 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. 

// Example sending a request using DescribeDBClusterParameterGroupsRequest.
req := client.DescribeDBClusterParameterGroupsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeDBClusterParametersRequest added in v0.9.0 

func (c *Client) DescribeDBClusterParametersRequest(input *DescribeDBClusterParametersInput) DescribeDBClusterParametersRequest

DescribeDBClusterParametersRequest returns a request value for making API operation for Amazon DocumentDB with MongoDB compatibility.

Returns the detailed parameter list for a particular DB cluster parameter group. 

// Example sending a request using DescribeDBClusterParametersRequest.
req := client.DescribeDBClusterParametersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeDBClusterSnapshotAttributesRequest added in v0.9.0 

func (c *Client) DescribeDBClusterSnapshotAttributesRequest(input *DescribeDBClusterSnapshotAttributesInput) DescribeDBClusterSnapshotAttributesRequest

DescribeDBClusterSnapshotAttributesRequest returns a request value for making 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. 

// Example sending a request using DescribeDBClusterSnapshotAttributesRequest.
req := client.DescribeDBClusterSnapshotAttributesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeDBClusterSnapshotsRequest added in v0.9.0 

func (c *Client) DescribeDBClusterSnapshotsRequest(input *DescribeDBClusterSnapshotsInput) DescribeDBClusterSnapshotsRequest

DescribeDBClusterSnapshotsRequest returns a request value for making API operation for Amazon DocumentDB with MongoDB compatibility.

Returns information about DB cluster snapshots. This API operation supports pagination. 

// Example sending a request using DescribeDBClusterSnapshotsRequest.
req := client.DescribeDBClusterSnapshotsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeDBClustersRequest added in v0.9.0 

func (c *Client) DescribeDBClustersRequest(input *DescribeDBClustersInput) DescribeDBClustersRequest

DescribeDBClustersRequest returns a request value for making API operation for Amazon DocumentDB with MongoDB compatibility.

Returns information about provisioned Amazon DocumentDB DB clusters. This API operation supports pagination. 

// Example sending a request using DescribeDBClustersRequest.
req := client.DescribeDBClustersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeDBEngineVersionsRequest added in v0.9.0 

func (c *Client) DescribeDBEngineVersionsRequest(input *DescribeDBEngineVersionsInput) DescribeDBEngineVersionsRequest

DescribeDBEngineVersionsRequest returns a request value for making API operation for Amazon DocumentDB with MongoDB compatibility.

Returns a list of the available DB engines. 

// Example sending a request using DescribeDBEngineVersionsRequest.
req := client.DescribeDBEngineVersionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBEngineVersions

func (*Client) DescribeDBInstancesRequest added in v0.9.0 

func (c *Client) DescribeDBInstancesRequest(input *DescribeDBInstancesInput) DescribeDBInstancesRequest

DescribeDBInstancesRequest returns a request value for making API operation for Amazon DocumentDB with MongoDB compatibility.

Returns information about provisioned Amazon DocumentDB instances. This API supports pagination. 

// Example sending a request using DescribeDBInstancesRequest.
req := client.DescribeDBInstancesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeDBSubnetGroupsRequest added in v0.9.0 

func (c *Client) DescribeDBSubnetGroupsRequest(input *DescribeDBSubnetGroupsInput) DescribeDBSubnetGroupsRequest

DescribeDBSubnetGroupsRequest returns a request value for making 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. 

// Example sending a request using DescribeDBSubnetGroupsRequest.
req := client.DescribeDBSubnetGroupsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeEngineDefaultClusterParametersRequest added in v0.9.0 

func (c *Client) DescribeEngineDefaultClusterParametersRequest(input *DescribeEngineDefaultClusterParametersInput) DescribeEngineDefaultClusterParametersRequest

DescribeEngineDefaultClusterParametersRequest returns a request value for making API operation for Amazon DocumentDB with MongoDB compatibility.

Returns the default engine and system parameter information for the cluster database engine. 

// Example sending a request using DescribeEngineDefaultClusterParametersRequest.
req := client.DescribeEngineDefaultClusterParametersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEngineDefaultClusterParameters

func (*Client) DescribeEventCategoriesRequest added in v0.9.0 

func (c *Client) DescribeEventCategoriesRequest(input *DescribeEventCategoriesInput) DescribeEventCategoriesRequest

DescribeEventCategoriesRequest returns a request value for making 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. 

// Example sending a request using DescribeEventCategoriesRequest.
req := client.DescribeEventCategoriesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEventCategories

func (*Client) DescribeEventsRequest added in v0.9.0 

func (c *Client) DescribeEventsRequest(input *DescribeEventsInput) DescribeEventsRequest

DescribeEventsRequest returns a request value for making 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. 

// Example sending a request using DescribeEventsRequest.
req := client.DescribeEventsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEvents

func (*Client) DescribeOrderableDBInstanceOptionsRequest added in v0.9.0 

func (c *Client) DescribeOrderableDBInstanceOptionsRequest(input *DescribeOrderableDBInstanceOptionsInput) DescribeOrderableDBInstanceOptionsRequest

DescribeOrderableDBInstanceOptionsRequest returns a request value for making API operation for Amazon DocumentDB with MongoDB compatibility.

Returns a list of orderable DB instance options for the specified engine. 

// Example sending a request using DescribeOrderableDBInstanceOptionsRequest.
req := client.DescribeOrderableDBInstanceOptionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeOrderableDBInstanceOptions

func (*Client) DescribePendingMaintenanceActionsRequest added in v0.9.0 

func (c *Client) DescribePendingMaintenanceActionsRequest(input *DescribePendingMaintenanceActionsInput) DescribePendingMaintenanceActionsRequest

DescribePendingMaintenanceActionsRequest returns a request value for making 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. 

// Example sending a request using DescribePendingMaintenanceActionsRequest.
req := client.DescribePendingMaintenanceActionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribePendingMaintenanceActions

func (*Client) FailoverDBClusterRequest added in v0.9.0 

func (c *Client) FailoverDBClusterRequest(input *FailoverDBClusterInput) FailoverDBClusterRequest

FailoverDBClusterRequest returns a request value for making 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. 

// Example sending a request using FailoverDBClusterRequest.
req := client.FailoverDBClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ListTagsForResourceRequest added in v0.9.0 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for Amazon DocumentDB with MongoDB compatibility.

Lists all tags on an Amazon DocumentDB resource. 

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ModifyDBClusterParameterGroupRequest added in v0.9.0 

func (c *Client) ModifyDBClusterParameterGroupRequest(input *ModifyDBClusterParameterGroupInput) ModifyDBClusterParameterGroupRequest

ModifyDBClusterParameterGroupRequest returns a request value for making 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. 

// Example sending a request using ModifyDBClusterParameterGroupRequest.
req := client.ModifyDBClusterParameterGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterParameterGroup

func (*Client) ModifyDBClusterRequest added in v0.9.0 

func (c *Client) ModifyDBClusterRequest(input *ModifyDBClusterInput) ModifyDBClusterRequest

ModifyDBClusterRequest returns a request value for making 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. 

// Example sending a request using ModifyDBClusterRequest.
req := client.ModifyDBClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ModifyDBClusterSnapshotAttributeRequest added in v0.9.0 

func (c *Client) ModifyDBClusterSnapshotAttributeRequest(input *ModifyDBClusterSnapshotAttributeInput) ModifyDBClusterSnapshotAttributeRequest

ModifyDBClusterSnapshotAttributeRequest returns a request value for making 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. 

// Example sending a request using ModifyDBClusterSnapshotAttributeRequest.
req := client.ModifyDBClusterSnapshotAttributeRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterSnapshotAttribute

func (*Client) ModifyDBInstanceRequest added in v0.9.0 

func (c *Client) ModifyDBInstanceRequest(input *ModifyDBInstanceInput) ModifyDBInstanceRequest

ModifyDBInstanceRequest returns a request value for making 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. 

// Example sending a request using ModifyDBInstanceRequest.
req := client.ModifyDBInstanceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBInstance

func (*Client) ModifyDBSubnetGroupRequest added in v0.9.0 

func (c *Client) ModifyDBSubnetGroupRequest(input *ModifyDBSubnetGroupInput) ModifyDBSubnetGroupRequest

ModifyDBSubnetGroupRequest returns a request value for making 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. 

// Example sending a request using ModifyDBSubnetGroupRequest.
req := client.ModifyDBSubnetGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBSubnetGroup

func (*Client) RebootDBInstanceRequest added in v0.9.0 

func (c *Client) RebootDBInstanceRequest(input *RebootDBInstanceInput) RebootDBInstanceRequest

RebootDBInstanceRequest returns a request value for making 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. 

// Example sending a request using RebootDBInstanceRequest.
req := client.RebootDBInstanceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) RemoveTagsFromResourceRequest added in v0.9.0 

func (c *Client) RemoveTagsFromResourceRequest(input *RemoveTagsFromResourceInput) RemoveTagsFromResourceRequest

RemoveTagsFromResourceRequest returns a request value for making API operation for Amazon DocumentDB with MongoDB compatibility.

Removes metadata tags from an Amazon DocumentDB resource. 

// Example sending a request using RemoveTagsFromResourceRequest.
req := client.RemoveTagsFromResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) ResetDBClusterParameterGroupRequest added in v0.9.0 

func (c *Client) ResetDBClusterParameterGroupRequest(input *ResetDBClusterParameterGroupInput) ResetDBClusterParameterGroupRequest

ResetDBClusterParameterGroupRequest returns a request value for making 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. 

// Example sending a request using ResetDBClusterParameterGroupRequest.
req := client.ResetDBClusterParameterGroupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) RestoreDBClusterFromSnapshotRequest added in v0.9.0 

func (c *Client) RestoreDBClusterFromSnapshotRequest(input *RestoreDBClusterFromSnapshotInput) RestoreDBClusterFromSnapshotRequest

RestoreDBClusterFromSnapshotRequest returns a request value for making 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. 

// Example sending a request using RestoreDBClusterFromSnapshotRequest.
req := client.RestoreDBClusterFromSnapshotRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) RestoreDBClusterToPointInTimeRequest added in v0.9.0 

func (c *Client) RestoreDBClusterToPointInTimeRequest(input *RestoreDBClusterToPointInTimeInput) RestoreDBClusterToPointInTimeRequest

RestoreDBClusterToPointInTimeRequest returns a request value for making 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. 

// Example sending a request using RestoreDBClusterToPointInTimeRequest.
req := client.RestoreDBClusterToPointInTimeRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) WaitUntilDBInstanceAvailable added in v0.9.0 

func (c *Client) WaitUntilDBInstanceAvailable(ctx context.Context, input *DescribeDBInstancesInput, opts ...aws.WaiterOption) 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.

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 (*Client) WaitUntilDBInstanceDeleted added in v0.9.0 

func (c *Client) WaitUntilDBInstanceDeleted(ctx context.Context, input *DescribeDBInstancesInput, opts ...aws.WaiterOption) 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.

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 CloudwatchLogsExportConfiguration 

type CloudwatchLogsExportConfiguration struct {

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

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

The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CloudwatchLogsExportConfiguration

func (CloudwatchLogsExportConfiguration) String 

func (s CloudwatchLogsExportConfiguration) String() string

String returns the string representation

type CopyDBClusterParameterGroupInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterParameterGroupMessage

func (CopyDBClusterParameterGroupInput) String 

func (s CopyDBClusterParameterGroupInput) String() string

String returns the string representation

func (*CopyDBClusterParameterGroupInput) Validate 

func (s *CopyDBClusterParameterGroupInput) Validate() error

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

type CopyDBClusterParameterGroupOutput 

type CopyDBClusterParameterGroupOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterParameterGroupResult

func (CopyDBClusterParameterGroupOutput) String 

func (s CopyDBClusterParameterGroupOutput) String() string

String returns the string representation

type CopyDBClusterParameterGroupRequest 

type CopyDBClusterParameterGroupRequest struct {
	*aws.Request
	Input *CopyDBClusterParameterGroupInput
	Copy  func(*CopyDBClusterParameterGroupInput) CopyDBClusterParameterGroupRequest
}

CopyDBClusterParameterGroupRequest is the request type for the CopyDBClusterParameterGroup API operation.

func (CopyDBClusterParameterGroupRequest) Send 

func (r CopyDBClusterParameterGroupRequest) Send(ctx context.Context) (*CopyDBClusterParameterGroupResponse, error)

Send marshals and sends the CopyDBClusterParameterGroup API request.

type CopyDBClusterParameterGroupResponse added in v0.9.0 

type CopyDBClusterParameterGroupResponse struct {
	*CopyDBClusterParameterGroupOutput
	// contains filtered or unexported fields
}

CopyDBClusterParameterGroupResponse is the response type for the CopyDBClusterParameterGroup API operation.

func (*CopyDBClusterParameterGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *CopyDBClusterParameterGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CopyDBClusterParameterGroup request.

type CopyDBClusterSnapshotInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterSnapshotMessage

func (CopyDBClusterSnapshotInput) String 

func (s CopyDBClusterSnapshotInput) String() string

String returns the string representation

func (*CopyDBClusterSnapshotInput) Validate 

func (s *CopyDBClusterSnapshotInput) Validate() error

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

type CopyDBClusterSnapshotOutput 

type CopyDBClusterSnapshotOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterSnapshotResult

func (CopyDBClusterSnapshotOutput) String 

func (s CopyDBClusterSnapshotOutput) String() string

String returns the string representation

type CopyDBClusterSnapshotRequest 

type CopyDBClusterSnapshotRequest struct {
	*aws.Request
	Input *CopyDBClusterSnapshotInput
	Copy  func(*CopyDBClusterSnapshotInput) CopyDBClusterSnapshotRequest
}

CopyDBClusterSnapshotRequest is the request type for the CopyDBClusterSnapshot API operation.

func (CopyDBClusterSnapshotRequest) Send 

func (r CopyDBClusterSnapshotRequest) Send(ctx context.Context) (*CopyDBClusterSnapshotResponse, error)

Send marshals and sends the CopyDBClusterSnapshot API request.

type CopyDBClusterSnapshotResponse added in v0.9.0 

type CopyDBClusterSnapshotResponse struct {
	*CopyDBClusterSnapshotOutput
	// contains filtered or unexported fields
}

CopyDBClusterSnapshotResponse is the response type for the CopyDBClusterSnapshot API operation.

func (*CopyDBClusterSnapshotResponse) SDKResponseMetdata added in v0.9.0 

func (r *CopyDBClusterSnapshotResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CopyDBClusterSnapshot request.

type CreateDBClusterInput 

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

	// 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 "/", """, or "@".
	//
	// Constraints: Must contain from 8 to 41 characters.
	MasterUserPassword *string `type:"string"`

	// 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 *string `type:"string"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterMessage

func (CreateDBClusterInput) String 

func (s CreateDBClusterInput) String() string

String returns the string representation

func (*CreateDBClusterInput) Validate 

func (s *CreateDBClusterInput) Validate() error

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

type CreateDBClusterOutput 

type CreateDBClusterOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterResult

func (CreateDBClusterOutput) String 

func (s CreateDBClusterOutput) String() string

String returns the string representation

type CreateDBClusterParameterGroupInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterParameterGroupMessage

func (CreateDBClusterParameterGroupInput) String 

func (s CreateDBClusterParameterGroupInput) String() string

String returns the string representation

func (*CreateDBClusterParameterGroupInput) Validate 

func (s *CreateDBClusterParameterGroupInput) Validate() error

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

type CreateDBClusterParameterGroupOutput 

type CreateDBClusterParameterGroupOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterParameterGroupResult

func (CreateDBClusterParameterGroupOutput) String 

func (s CreateDBClusterParameterGroupOutput) String() string

String returns the string representation

type CreateDBClusterParameterGroupRequest 

type CreateDBClusterParameterGroupRequest struct {
	*aws.Request
	Input *CreateDBClusterParameterGroupInput
	Copy  func(*CreateDBClusterParameterGroupInput) CreateDBClusterParameterGroupRequest
}

CreateDBClusterParameterGroupRequest is the request type for the CreateDBClusterParameterGroup API operation.

func (CreateDBClusterParameterGroupRequest) Send 

func (r CreateDBClusterParameterGroupRequest) Send(ctx context.Context) (*CreateDBClusterParameterGroupResponse, error)

Send marshals and sends the CreateDBClusterParameterGroup API request.

type CreateDBClusterParameterGroupResponse added in v0.9.0 

type CreateDBClusterParameterGroupResponse struct {
	*CreateDBClusterParameterGroupOutput
	// contains filtered or unexported fields
}

CreateDBClusterParameterGroupResponse is the response type for the CreateDBClusterParameterGroup API operation.

func (*CreateDBClusterParameterGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateDBClusterParameterGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateDBClusterParameterGroup request.

type CreateDBClusterRequest 

type CreateDBClusterRequest struct {
	*aws.Request
	Input *CreateDBClusterInput
	Copy  func(*CreateDBClusterInput) CreateDBClusterRequest
}

CreateDBClusterRequest is the request type for the CreateDBCluster API operation.

func (CreateDBClusterRequest) Send 

func (r CreateDBClusterRequest) Send(ctx context.Context) (*CreateDBClusterResponse, error)

Send marshals and sends the CreateDBCluster API request.

type CreateDBClusterResponse added in v0.9.0 

type CreateDBClusterResponse struct {
	*CreateDBClusterOutput
	// contains filtered or unexported fields
}

CreateDBClusterResponse is the response type for the CreateDBCluster API operation.

func (*CreateDBClusterResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateDBClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateDBCluster request.

type CreateDBClusterSnapshotInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterSnapshotMessage

func (CreateDBClusterSnapshotInput) String 

func (s CreateDBClusterSnapshotInput) String() string

String returns the string representation

func (*CreateDBClusterSnapshotInput) Validate 

func (s *CreateDBClusterSnapshotInput) Validate() error

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

type CreateDBClusterSnapshotOutput 

type CreateDBClusterSnapshotOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterSnapshotResult

func (CreateDBClusterSnapshotOutput) String 

func (s CreateDBClusterSnapshotOutput) String() string

String returns the string representation

type CreateDBClusterSnapshotRequest 

type CreateDBClusterSnapshotRequest struct {
	*aws.Request
	Input *CreateDBClusterSnapshotInput
	Copy  func(*CreateDBClusterSnapshotInput) CreateDBClusterSnapshotRequest
}

CreateDBClusterSnapshotRequest is the request type for the CreateDBClusterSnapshot API operation.

func (CreateDBClusterSnapshotRequest) Send 

func (r CreateDBClusterSnapshotRequest) Send(ctx context.Context) (*CreateDBClusterSnapshotResponse, error)

Send marshals and sends the CreateDBClusterSnapshot API request.

type CreateDBClusterSnapshotResponse added in v0.9.0 

type CreateDBClusterSnapshotResponse struct {
	*CreateDBClusterSnapshotOutput
	// contains filtered or unexported fields
}

CreateDBClusterSnapshotResponse is the response type for the CreateDBClusterSnapshot API operation.

func (*CreateDBClusterSnapshotResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateDBClusterSnapshotResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateDBClusterSnapshot request.

type CreateDBInstanceInput 

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.m4.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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBInstanceMessage

func (CreateDBInstanceInput) String 

func (s CreateDBInstanceInput) String() string

String returns the string representation

func (*CreateDBInstanceInput) Validate 

func (s *CreateDBInstanceInput) Validate() error

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

type CreateDBInstanceOutput 

type CreateDBInstanceOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBInstanceResult

func (CreateDBInstanceOutput) String 

func (s CreateDBInstanceOutput) String() string

String returns the string representation

type CreateDBInstanceRequest 

type CreateDBInstanceRequest struct {
	*aws.Request
	Input *CreateDBInstanceInput
	Copy  func(*CreateDBInstanceInput) CreateDBInstanceRequest
}

CreateDBInstanceRequest is the request type for the CreateDBInstance API operation.

func (CreateDBInstanceRequest) Send 

func (r CreateDBInstanceRequest) Send(ctx context.Context) (*CreateDBInstanceResponse, error)

Send marshals and sends the CreateDBInstance API request.

type CreateDBInstanceResponse added in v0.9.0 

type CreateDBInstanceResponse struct {
	*CreateDBInstanceOutput
	// contains filtered or unexported fields
}

CreateDBInstanceResponse is the response type for the CreateDBInstance API operation.

func (*CreateDBInstanceResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateDBInstanceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateDBInstance request.

type CreateDBSubnetGroupInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBSubnetGroupMessage

func (CreateDBSubnetGroupInput) String 

func (s CreateDBSubnetGroupInput) String() string

String returns the string representation

func (*CreateDBSubnetGroupInput) Validate 

func (s *CreateDBSubnetGroupInput) Validate() error

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

type CreateDBSubnetGroupOutput 

type CreateDBSubnetGroupOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBSubnetGroupResult

func (CreateDBSubnetGroupOutput) String 

func (s CreateDBSubnetGroupOutput) String() string

String returns the string representation

type CreateDBSubnetGroupRequest 

type CreateDBSubnetGroupRequest struct {
	*aws.Request
	Input *CreateDBSubnetGroupInput
	Copy  func(*CreateDBSubnetGroupInput) CreateDBSubnetGroupRequest
}

CreateDBSubnetGroupRequest is the request type for the CreateDBSubnetGroup API operation.

func (CreateDBSubnetGroupRequest) Send 

func (r CreateDBSubnetGroupRequest) Send(ctx context.Context) (*CreateDBSubnetGroupResponse, error)

Send marshals and sends the CreateDBSubnetGroup API request.

type CreateDBSubnetGroupResponse added in v0.9.0 

type CreateDBSubnetGroupResponse struct {
	*CreateDBSubnetGroupOutput
	// contains filtered or unexported fields
}

CreateDBSubnetGroupResponse is the response type for the CreateDBSubnetGroup API operation.

func (*CreateDBSubnetGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateDBSubnetGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateDBSubnetGroup request.

type DBCluster 

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" timestampFormat:"iso8601"`

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

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

	// 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" timestampFormat:"iso8601"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBCluster

func (DBCluster) String 

func (s DBCluster) String() string

String returns the string representation

type DBClusterMember 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterMember

func (DBClusterMember) String 

func (s DBClusterMember) String() string

String returns the string representation

type DBClusterParameterGroup 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterParameterGroup

func (DBClusterParameterGroup) String 

func (s DBClusterParameterGroup) String() string

String returns the string representation

type DBClusterRole 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterRole

func (DBClusterRole) String 

func (s DBClusterRole) String() string

String returns the string representation

type DBClusterSnapshot 

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" timestampFormat:"iso8601"`

	// 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" timestampFormat:"iso8601"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterSnapshot

func (DBClusterSnapshot) String 

func (s DBClusterSnapshot) String() string

String returns the string representation

type DBClusterSnapshotAttribute 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterSnapshotAttribute

func (DBClusterSnapshotAttribute) String 

func (s DBClusterSnapshotAttribute) String() string

String returns the string representation

type DBClusterSnapshotAttributesResult 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterSnapshotAttributesResult

func (DBClusterSnapshotAttributesResult) String 

func (s DBClusterSnapshotAttributesResult) String() string

String returns the string representation

type DBEngineVersion 

type DBEngineVersion struct {

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

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

	// The name of the 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBEngineVersion

func (DBEngineVersion) String 

func (s DBEngineVersion) String() string

String returns the string representation

type DBInstance 

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" timestampFormat:"iso8601"`

	// 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" timestampFormat:"iso8601"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBInstance

func (DBInstance) String 

func (s DBInstance) String() string

String returns the string representation

type DBInstanceStatusInfo 

type DBInstanceStatusInfo struct {

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

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

	// Status of the 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBInstanceStatusInfo

func (DBInstanceStatusInfo) String 

func (s DBInstanceStatusInfo) String() string

String returns the string representation

type DBSubnetGroup 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBSubnetGroup

func (DBSubnetGroup) String 

func (s DBSubnetGroup) String() string

String returns the string representation

type DeleteDBClusterInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterMessage

func (DeleteDBClusterInput) String 

func (s DeleteDBClusterInput) String() string

String returns the string representation

func (*DeleteDBClusterInput) Validate 

func (s *DeleteDBClusterInput) Validate() error

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

type DeleteDBClusterOutput 

type DeleteDBClusterOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterResult

func (DeleteDBClusterOutput) String 

func (s DeleteDBClusterOutput) String() string

String returns the string representation

type DeleteDBClusterParameterGroupInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterParameterGroupMessage

func (DeleteDBClusterParameterGroupInput) String 

func (s DeleteDBClusterParameterGroupInput) String() string

String returns the string representation

func (*DeleteDBClusterParameterGroupInput) Validate 

func (s *DeleteDBClusterParameterGroupInput) Validate() error

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

type DeleteDBClusterParameterGroupOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterParameterGroupOutput

func (DeleteDBClusterParameterGroupOutput) String 

func (s DeleteDBClusterParameterGroupOutput) String() string

String returns the string representation

type DeleteDBClusterParameterGroupRequest 

type DeleteDBClusterParameterGroupRequest struct {
	*aws.Request
	Input *DeleteDBClusterParameterGroupInput
	Copy  func(*DeleteDBClusterParameterGroupInput) DeleteDBClusterParameterGroupRequest
}

DeleteDBClusterParameterGroupRequest is the request type for the DeleteDBClusterParameterGroup API operation.

func (DeleteDBClusterParameterGroupRequest) Send 

func (r DeleteDBClusterParameterGroupRequest) Send(ctx context.Context) (*DeleteDBClusterParameterGroupResponse, error)

Send marshals and sends the DeleteDBClusterParameterGroup API request.

type DeleteDBClusterParameterGroupResponse added in v0.9.0 

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

DeleteDBClusterParameterGroupResponse is the response type for the DeleteDBClusterParameterGroup API operation.

func (*DeleteDBClusterParameterGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteDBClusterParameterGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteDBClusterParameterGroup request.

type DeleteDBClusterRequest 

type DeleteDBClusterRequest struct {
	*aws.Request
	Input *DeleteDBClusterInput
	Copy  func(*DeleteDBClusterInput) DeleteDBClusterRequest
}

DeleteDBClusterRequest is the request type for the DeleteDBCluster API operation.

func (DeleteDBClusterRequest) Send 

func (r DeleteDBClusterRequest) Send(ctx context.Context) (*DeleteDBClusterResponse, error)

Send marshals and sends the DeleteDBCluster API request.

type DeleteDBClusterResponse added in v0.9.0 

type DeleteDBClusterResponse struct {
	*DeleteDBClusterOutput
	// contains filtered or unexported fields
}

DeleteDBClusterResponse is the response type for the DeleteDBCluster API operation.

func (*DeleteDBClusterResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteDBClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteDBCluster request.

type DeleteDBClusterSnapshotInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterSnapshotMessage

func (DeleteDBClusterSnapshotInput) String 

func (s DeleteDBClusterSnapshotInput) String() string

String returns the string representation

func (*DeleteDBClusterSnapshotInput) Validate 

func (s *DeleteDBClusterSnapshotInput) Validate() error

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

type DeleteDBClusterSnapshotOutput 

type DeleteDBClusterSnapshotOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBClusterSnapshotResult

func (DeleteDBClusterSnapshotOutput) String 

func (s DeleteDBClusterSnapshotOutput) String() string

String returns the string representation

type DeleteDBClusterSnapshotRequest 

type DeleteDBClusterSnapshotRequest struct {
	*aws.Request
	Input *DeleteDBClusterSnapshotInput
	Copy  func(*DeleteDBClusterSnapshotInput) DeleteDBClusterSnapshotRequest
}

DeleteDBClusterSnapshotRequest is the request type for the DeleteDBClusterSnapshot API operation.

func (DeleteDBClusterSnapshotRequest) Send 

func (r DeleteDBClusterSnapshotRequest) Send(ctx context.Context) (*DeleteDBClusterSnapshotResponse, error)

Send marshals and sends the DeleteDBClusterSnapshot API request.

type DeleteDBClusterSnapshotResponse added in v0.9.0 

type DeleteDBClusterSnapshotResponse struct {
	*DeleteDBClusterSnapshotOutput
	// contains filtered or unexported fields
}

DeleteDBClusterSnapshotResponse is the response type for the DeleteDBClusterSnapshot API operation.

func (*DeleteDBClusterSnapshotResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteDBClusterSnapshotResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteDBClusterSnapshot request.

type DeleteDBInstanceInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBInstanceMessage

func (DeleteDBInstanceInput) String 

func (s DeleteDBInstanceInput) String() string

String returns the string representation

func (*DeleteDBInstanceInput) Validate 

func (s *DeleteDBInstanceInput) Validate() error

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

type DeleteDBInstanceOutput 

type DeleteDBInstanceOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBInstanceResult

func (DeleteDBInstanceOutput) String 

func (s DeleteDBInstanceOutput) String() string

String returns the string representation

type DeleteDBInstanceRequest 

type DeleteDBInstanceRequest struct {
	*aws.Request
	Input *DeleteDBInstanceInput
	Copy  func(*DeleteDBInstanceInput) DeleteDBInstanceRequest
}

DeleteDBInstanceRequest is the request type for the DeleteDBInstance API operation.

func (DeleteDBInstanceRequest) Send 

func (r DeleteDBInstanceRequest) Send(ctx context.Context) (*DeleteDBInstanceResponse, error)

Send marshals and sends the DeleteDBInstance API request.

type DeleteDBInstanceResponse added in v0.9.0 

type DeleteDBInstanceResponse struct {
	*DeleteDBInstanceOutput
	// contains filtered or unexported fields
}

DeleteDBInstanceResponse is the response type for the DeleteDBInstance API operation.

func (*DeleteDBInstanceResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteDBInstanceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteDBInstance request.

type DeleteDBSubnetGroupInput 

type DeleteDBSubnetGroupInput struct {

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

Represents the input to DeleteDBSubnetGroup. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBSubnetGroupMessage

func (DeleteDBSubnetGroupInput) String 

func (s DeleteDBSubnetGroupInput) String() string

String returns the string representation

func (*DeleteDBSubnetGroupInput) Validate 

func (s *DeleteDBSubnetGroupInput) Validate() error

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

type DeleteDBSubnetGroupOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DeleteDBSubnetGroupOutput

func (DeleteDBSubnetGroupOutput) String 

func (s DeleteDBSubnetGroupOutput) String() string

String returns the string representation

type DeleteDBSubnetGroupRequest 

type DeleteDBSubnetGroupRequest struct {
	*aws.Request
	Input *DeleteDBSubnetGroupInput
	Copy  func(*DeleteDBSubnetGroupInput) DeleteDBSubnetGroupRequest
}

DeleteDBSubnetGroupRequest is the request type for the DeleteDBSubnetGroup API operation.

func (DeleteDBSubnetGroupRequest) Send 

func (r DeleteDBSubnetGroupRequest) Send(ctx context.Context) (*DeleteDBSubnetGroupResponse, error)

Send marshals and sends the DeleteDBSubnetGroup API request.

type DeleteDBSubnetGroupResponse added in v0.9.0 

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

DeleteDBSubnetGroupResponse is the response type for the DeleteDBSubnetGroup API operation.

func (*DeleteDBSubnetGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteDBSubnetGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteDBSubnetGroup request.

type DescribeDBClusterParameterGroupsInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterParameterGroupsMessage

func (DescribeDBClusterParameterGroupsInput) String 

func (s DescribeDBClusterParameterGroupsInput) String() string

String returns the string representation

func (*DescribeDBClusterParameterGroupsInput) Validate 

func (s *DescribeDBClusterParameterGroupsInput) Validate() error

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

type DescribeDBClusterParameterGroupsOutput 

type DescribeDBClusterParameterGroupsOutput struct {

	// A list of 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterParameterGroupsMessage

func (DescribeDBClusterParameterGroupsOutput) String 

func (s DescribeDBClusterParameterGroupsOutput) String() string

String returns the string representation

type DescribeDBClusterParameterGroupsRequest 

type DescribeDBClusterParameterGroupsRequest struct {
	*aws.Request
	Input *DescribeDBClusterParameterGroupsInput
	Copy  func(*DescribeDBClusterParameterGroupsInput) DescribeDBClusterParameterGroupsRequest
}

DescribeDBClusterParameterGroupsRequest is the request type for the DescribeDBClusterParameterGroups API operation.

func (DescribeDBClusterParameterGroupsRequest) Send 

func (r DescribeDBClusterParameterGroupsRequest) Send(ctx context.Context) (*DescribeDBClusterParameterGroupsResponse, error)

Send marshals and sends the DescribeDBClusterParameterGroups API request.

type DescribeDBClusterParameterGroupsResponse added in v0.9.0 

type DescribeDBClusterParameterGroupsResponse struct {
	*DescribeDBClusterParameterGroupsOutput
	// contains filtered or unexported fields
}

DescribeDBClusterParameterGroupsResponse is the response type for the DescribeDBClusterParameterGroups API operation.

func (*DescribeDBClusterParameterGroupsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeDBClusterParameterGroupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDBClusterParameterGroups request.

type DescribeDBClusterParametersInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterParametersMessage

func (DescribeDBClusterParametersInput) String 

func (s DescribeDBClusterParametersInput) String() string

String returns the string representation

func (*DescribeDBClusterParametersInput) Validate 

func (s *DescribeDBClusterParametersInput) Validate() error

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

type DescribeDBClusterParametersOutput 

type DescribeDBClusterParametersOutput struct {

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

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

Represents the output of DBClusterParameterGroup. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterParameterGroupDetails

func (DescribeDBClusterParametersOutput) String 

func (s DescribeDBClusterParametersOutput) String() string

String returns the string representation

type DescribeDBClusterParametersRequest 

type DescribeDBClusterParametersRequest struct {
	*aws.Request
	Input *DescribeDBClusterParametersInput
	Copy  func(*DescribeDBClusterParametersInput) DescribeDBClusterParametersRequest
}

DescribeDBClusterParametersRequest is the request type for the DescribeDBClusterParameters API operation.

func (DescribeDBClusterParametersRequest) Send 

func (r DescribeDBClusterParametersRequest) Send(ctx context.Context) (*DescribeDBClusterParametersResponse, error)

Send marshals and sends the DescribeDBClusterParameters API request.

type DescribeDBClusterParametersResponse added in v0.9.0 

type DescribeDBClusterParametersResponse struct {
	*DescribeDBClusterParametersOutput
	// contains filtered or unexported fields
}

DescribeDBClusterParametersResponse is the response type for the DescribeDBClusterParameters API operation.

func (*DescribeDBClusterParametersResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeDBClusterParametersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDBClusterParameters request.

type DescribeDBClusterSnapshotAttributesInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshotAttributesMessage

func (DescribeDBClusterSnapshotAttributesInput) String 

func (s DescribeDBClusterSnapshotAttributesInput) String() string

String returns the string representation

func (*DescribeDBClusterSnapshotAttributesInput) Validate 

func (s *DescribeDBClusterSnapshotAttributesInput) Validate() error

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

type DescribeDBClusterSnapshotAttributesOutput 

type DescribeDBClusterSnapshotAttributesOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshotAttributesResult

func (DescribeDBClusterSnapshotAttributesOutput) String 

func (s DescribeDBClusterSnapshotAttributesOutput) String() string

String returns the string representation

type DescribeDBClusterSnapshotAttributesRequest 

type DescribeDBClusterSnapshotAttributesRequest struct {
	*aws.Request
	Input *DescribeDBClusterSnapshotAttributesInput
	Copy  func(*DescribeDBClusterSnapshotAttributesInput) DescribeDBClusterSnapshotAttributesRequest
}

DescribeDBClusterSnapshotAttributesRequest is the request type for the DescribeDBClusterSnapshotAttributes API operation.

func (DescribeDBClusterSnapshotAttributesRequest) Send 

func (r DescribeDBClusterSnapshotAttributesRequest) Send(ctx context.Context) (*DescribeDBClusterSnapshotAttributesResponse, error)

Send marshals and sends the DescribeDBClusterSnapshotAttributes API request.

type DescribeDBClusterSnapshotAttributesResponse added in v0.9.0 

type DescribeDBClusterSnapshotAttributesResponse struct {
	*DescribeDBClusterSnapshotAttributesOutput
	// contains filtered or unexported fields
}

DescribeDBClusterSnapshotAttributesResponse is the response type for the DescribeDBClusterSnapshotAttributes API operation.

func (*DescribeDBClusterSnapshotAttributesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeDBClusterSnapshotAttributesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDBClusterSnapshotAttributes request.

type DescribeDBClusterSnapshotsInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClusterSnapshotsMessage

func (DescribeDBClusterSnapshotsInput) String 

func (s DescribeDBClusterSnapshotsInput) String() string

String returns the string representation

func (*DescribeDBClusterSnapshotsInput) Validate 

func (s *DescribeDBClusterSnapshotsInput) Validate() error

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

type DescribeDBClusterSnapshotsOutput 

type DescribeDBClusterSnapshotsOutput struct {

	// Provides a list of 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterSnapshotMessage

func (DescribeDBClusterSnapshotsOutput) String 

func (s DescribeDBClusterSnapshotsOutput) String() string

String returns the string representation

type DescribeDBClusterSnapshotsRequest 

type DescribeDBClusterSnapshotsRequest struct {
	*aws.Request
	Input *DescribeDBClusterSnapshotsInput
	Copy  func(*DescribeDBClusterSnapshotsInput) DescribeDBClusterSnapshotsRequest
}

DescribeDBClusterSnapshotsRequest is the request type for the DescribeDBClusterSnapshots API operation.

func (DescribeDBClusterSnapshotsRequest) Send 

func (r DescribeDBClusterSnapshotsRequest) Send(ctx context.Context) (*DescribeDBClusterSnapshotsResponse, error)

Send marshals and sends the DescribeDBClusterSnapshots API request.

type DescribeDBClusterSnapshotsResponse added in v0.9.0 

type DescribeDBClusterSnapshotsResponse struct {
	*DescribeDBClusterSnapshotsOutput
	// contains filtered or unexported fields
}

DescribeDBClusterSnapshotsResponse is the response type for the DescribeDBClusterSnapshots API operation.

func (*DescribeDBClusterSnapshotsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeDBClusterSnapshotsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDBClusterSnapshots request.

type DescribeDBClustersInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBClustersMessage

func (DescribeDBClustersInput) String 

func (s DescribeDBClustersInput) String() string

String returns the string representation

func (*DescribeDBClustersInput) Validate 

func (s *DescribeDBClustersInput) Validate() error

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

type DescribeDBClustersOutput 

type DescribeDBClustersOutput struct {

	// A list of 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterMessage

func (DescribeDBClustersOutput) String 

func (s DescribeDBClustersOutput) String() string

String returns the string representation

type DescribeDBClustersPaginator added in v0.9.0 

type DescribeDBClustersPaginator struct {
	aws.Pager
}

DescribeDBClustersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeDBClustersPaginator added in v0.9.0 

func NewDescribeDBClustersPaginator(req DescribeDBClustersRequest) DescribeDBClustersPaginator

NewDescribeDBClustersRequestPaginator returns a paginator for DescribeDBClusters. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.DescribeDBClustersRequest(input)
p := docdb.NewDescribeDBClustersRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeDBClustersPaginator) CurrentPage added in v0.9.0 

func (p *DescribeDBClustersPaginator) CurrentPage() *DescribeDBClustersOutput

type DescribeDBClustersRequest 

type DescribeDBClustersRequest struct {
	*aws.Request
	Input *DescribeDBClustersInput
	Copy  func(*DescribeDBClustersInput) DescribeDBClustersRequest
}

DescribeDBClustersRequest is the request type for the DescribeDBClusters API operation.

func (DescribeDBClustersRequest) Send 

func (r DescribeDBClustersRequest) Send(ctx context.Context) (*DescribeDBClustersResponse, error)

Send marshals and sends the DescribeDBClusters API request.

type DescribeDBClustersResponse added in v0.9.0 

type DescribeDBClustersResponse struct {
	*DescribeDBClustersOutput
	// contains filtered or unexported fields
}

DescribeDBClustersResponse is the response type for the DescribeDBClusters API operation.

func (*DescribeDBClustersResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeDBClustersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDBClusters request.

type DescribeDBEngineVersionsInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBEngineVersionsMessage

func (DescribeDBEngineVersionsInput) String 

func (s DescribeDBEngineVersionsInput) String() string

String returns the string representation

func (*DescribeDBEngineVersionsInput) Validate 

func (s *DescribeDBEngineVersionsInput) Validate() error

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

type DescribeDBEngineVersionsOutput 

type DescribeDBEngineVersionsOutput struct {

	// Detailed information about one or more 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBEngineVersionMessage

func (DescribeDBEngineVersionsOutput) String 

func (s DescribeDBEngineVersionsOutput) String() string

String returns the string representation

type DescribeDBEngineVersionsPaginator added in v0.9.0 

type DescribeDBEngineVersionsPaginator struct {
	aws.Pager
}

DescribeDBEngineVersionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeDBEngineVersionsPaginator added in v0.9.0 

func NewDescribeDBEngineVersionsPaginator(req DescribeDBEngineVersionsRequest) DescribeDBEngineVersionsPaginator

NewDescribeDBEngineVersionsRequestPaginator returns a paginator for DescribeDBEngineVersions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.DescribeDBEngineVersionsRequest(input)
p := docdb.NewDescribeDBEngineVersionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeDBEngineVersionsPaginator) CurrentPage added in v0.9.0 

func (p *DescribeDBEngineVersionsPaginator) CurrentPage() *DescribeDBEngineVersionsOutput

type DescribeDBEngineVersionsRequest 

type DescribeDBEngineVersionsRequest struct {
	*aws.Request
	Input *DescribeDBEngineVersionsInput
	Copy  func(*DescribeDBEngineVersionsInput) DescribeDBEngineVersionsRequest
}

DescribeDBEngineVersionsRequest is the request type for the DescribeDBEngineVersions API operation.

func (DescribeDBEngineVersionsRequest) Send 

func (r DescribeDBEngineVersionsRequest) Send(ctx context.Context) (*DescribeDBEngineVersionsResponse, error)

Send marshals and sends the DescribeDBEngineVersions API request.

type DescribeDBEngineVersionsResponse added in v0.9.0 

type DescribeDBEngineVersionsResponse struct {
	*DescribeDBEngineVersionsOutput
	// contains filtered or unexported fields
}

DescribeDBEngineVersionsResponse is the response type for the DescribeDBEngineVersions API operation.

func (*DescribeDBEngineVersionsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeDBEngineVersionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDBEngineVersions request.

type DescribeDBInstancesInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBInstancesMessage

func (DescribeDBInstancesInput) String 

func (s DescribeDBInstancesInput) String() string

String returns the string representation

func (*DescribeDBInstancesInput) Validate 

func (s *DescribeDBInstancesInput) Validate() error

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

type DescribeDBInstancesOutput 

type DescribeDBInstancesOutput struct {

	// Detailed information about one or more 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBInstanceMessage

func (DescribeDBInstancesOutput) String 

func (s DescribeDBInstancesOutput) String() string

String returns the string representation

type DescribeDBInstancesPaginator added in v0.9.0 

type DescribeDBInstancesPaginator struct {
	aws.Pager
}

DescribeDBInstancesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeDBInstancesPaginator added in v0.9.0 

func NewDescribeDBInstancesPaginator(req DescribeDBInstancesRequest) DescribeDBInstancesPaginator

NewDescribeDBInstancesRequestPaginator returns a paginator for DescribeDBInstances. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.DescribeDBInstancesRequest(input)
p := docdb.NewDescribeDBInstancesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeDBInstancesPaginator) CurrentPage added in v0.9.0 

func (p *DescribeDBInstancesPaginator) CurrentPage() *DescribeDBInstancesOutput

type DescribeDBInstancesRequest 

type DescribeDBInstancesRequest struct {
	*aws.Request
	Input *DescribeDBInstancesInput
	Copy  func(*DescribeDBInstancesInput) DescribeDBInstancesRequest
}

DescribeDBInstancesRequest is the request type for the DescribeDBInstances API operation.

func (DescribeDBInstancesRequest) Send 

func (r DescribeDBInstancesRequest) Send(ctx context.Context) (*DescribeDBInstancesResponse, error)

Send marshals and sends the DescribeDBInstances API request.

type DescribeDBInstancesResponse added in v0.9.0 

type DescribeDBInstancesResponse struct {
	*DescribeDBInstancesOutput
	// contains filtered or unexported fields
}

DescribeDBInstancesResponse is the response type for the DescribeDBInstances API operation.

func (*DescribeDBInstancesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeDBInstancesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDBInstances request.

type DescribeDBSubnetGroupsInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeDBSubnetGroupsMessage

func (DescribeDBSubnetGroupsInput) String 

func (s DescribeDBSubnetGroupsInput) String() string

String returns the string representation

func (*DescribeDBSubnetGroupsInput) Validate 

func (s *DescribeDBSubnetGroupsInput) Validate() error

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

type DescribeDBSubnetGroupsOutput 

type DescribeDBSubnetGroupsOutput struct {

	// Detailed information about one or more 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBSubnetGroupMessage

func (DescribeDBSubnetGroupsOutput) String 

func (s DescribeDBSubnetGroupsOutput) String() string

String returns the string representation

type DescribeDBSubnetGroupsPaginator added in v0.9.0 

type DescribeDBSubnetGroupsPaginator struct {
	aws.Pager
}

DescribeDBSubnetGroupsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeDBSubnetGroupsPaginator added in v0.9.0 

func NewDescribeDBSubnetGroupsPaginator(req DescribeDBSubnetGroupsRequest) DescribeDBSubnetGroupsPaginator

NewDescribeDBSubnetGroupsRequestPaginator returns a paginator for DescribeDBSubnetGroups. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.DescribeDBSubnetGroupsRequest(input)
p := docdb.NewDescribeDBSubnetGroupsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeDBSubnetGroupsPaginator) CurrentPage added in v0.9.0 

func (p *DescribeDBSubnetGroupsPaginator) CurrentPage() *DescribeDBSubnetGroupsOutput

type DescribeDBSubnetGroupsRequest 

type DescribeDBSubnetGroupsRequest struct {
	*aws.Request
	Input *DescribeDBSubnetGroupsInput
	Copy  func(*DescribeDBSubnetGroupsInput) DescribeDBSubnetGroupsRequest
}

DescribeDBSubnetGroupsRequest is the request type for the DescribeDBSubnetGroups API operation.

func (DescribeDBSubnetGroupsRequest) Send 

func (r DescribeDBSubnetGroupsRequest) Send(ctx context.Context) (*DescribeDBSubnetGroupsResponse, error)

Send marshals and sends the DescribeDBSubnetGroups API request.

type DescribeDBSubnetGroupsResponse added in v0.9.0 

type DescribeDBSubnetGroupsResponse struct {
	*DescribeDBSubnetGroupsOutput
	// contains filtered or unexported fields
}

DescribeDBSubnetGroupsResponse is the response type for the DescribeDBSubnetGroups API operation.

func (*DescribeDBSubnetGroupsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeDBSubnetGroupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeDBSubnetGroups request.

type DescribeEngineDefaultClusterParametersInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEngineDefaultClusterParametersMessage

func (DescribeEngineDefaultClusterParametersInput) String 

func (s DescribeEngineDefaultClusterParametersInput) String() string

String returns the string representation

func (*DescribeEngineDefaultClusterParametersInput) Validate 

func (s *DescribeEngineDefaultClusterParametersInput) Validate() error

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

type DescribeEngineDefaultClusterParametersOutput 

type DescribeEngineDefaultClusterParametersOutput struct {

	// Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters
	// operation.
	EngineDefaults *EngineDefaults `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEngineDefaultClusterParametersResult

func (DescribeEngineDefaultClusterParametersOutput) String 

func (s DescribeEngineDefaultClusterParametersOutput) String() string

String returns the string representation

type DescribeEngineDefaultClusterParametersRequest 

type DescribeEngineDefaultClusterParametersRequest struct {
	*aws.Request
	Input *DescribeEngineDefaultClusterParametersInput
	Copy  func(*DescribeEngineDefaultClusterParametersInput) DescribeEngineDefaultClusterParametersRequest
}

DescribeEngineDefaultClusterParametersRequest is the request type for the DescribeEngineDefaultClusterParameters API operation.

func (DescribeEngineDefaultClusterParametersRequest) Send 

func (r DescribeEngineDefaultClusterParametersRequest) Send(ctx context.Context) (*DescribeEngineDefaultClusterParametersResponse, error)

Send marshals and sends the DescribeEngineDefaultClusterParameters API request.

type DescribeEngineDefaultClusterParametersResponse added in v0.9.0 

type DescribeEngineDefaultClusterParametersResponse struct {
	*DescribeEngineDefaultClusterParametersOutput
	// contains filtered or unexported fields
}

DescribeEngineDefaultClusterParametersResponse is the response type for the DescribeEngineDefaultClusterParameters API operation.

func (*DescribeEngineDefaultClusterParametersResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeEngineDefaultClusterParametersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEngineDefaultClusterParameters request.

type DescribeEventCategoriesInput 

type DescribeEventCategoriesInput struct {

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

	// The type of source that is generating the events.
	//
	// Valid values: db-instance, db-parameter-group, db-security-group, db-snapshot
	SourceType *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the input to DescribeEventCategories. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEventCategoriesMessage

func (DescribeEventCategoriesInput) String 

func (s DescribeEventCategoriesInput) String() string

String returns the string representation

func (*DescribeEventCategoriesInput) Validate 

func (s *DescribeEventCategoriesInput) Validate() error

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

type DescribeEventCategoriesOutput 

type DescribeEventCategoriesOutput struct {

	// A list of event category maps.
	EventCategoriesMapList []EventCategoriesMap `locationNameList:"EventCategoriesMap" type:"list"`
	// contains filtered or unexported fields
}

Represents the output of DescribeEventCategories. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/EventCategoriesMessage

func (DescribeEventCategoriesOutput) String 

func (s DescribeEventCategoriesOutput) String() string

String returns the string representation

type DescribeEventCategoriesRequest 

type DescribeEventCategoriesRequest struct {
	*aws.Request
	Input *DescribeEventCategoriesInput
	Copy  func(*DescribeEventCategoriesInput) DescribeEventCategoriesRequest
}

DescribeEventCategoriesRequest is the request type for the DescribeEventCategories API operation.

func (DescribeEventCategoriesRequest) Send 

func (r DescribeEventCategoriesRequest) Send(ctx context.Context) (*DescribeEventCategoriesResponse, error)

Send marshals and sends the DescribeEventCategories API request.

type DescribeEventCategoriesResponse added in v0.9.0 

type DescribeEventCategoriesResponse struct {
	*DescribeEventCategoriesOutput
	// contains filtered or unexported fields
}

DescribeEventCategoriesResponse is the response type for the DescribeEventCategories API operation.

func (*DescribeEventCategoriesResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeEventCategoriesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEventCategories request.

type DescribeEventsInput 

type DescribeEventsInput struct {

	// The number of minutes to retrieve events for.
	//
	// Default: 60
	Duration *int64 `type:"integer"`

	// The end of the time interval for which to retrieve events, specified in ISO
	// 8601 format.
	//
	// Example: 2009-07-08T18:00Z
	EndTime *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// 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 SourceType `type:"string" enum:"true"`

	// 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" timestampFormat:"iso8601"`
	// contains filtered or unexported fields
}

Represents the input to DescribeEvents. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeEventsMessage

func (DescribeEventsInput) String 

func (s DescribeEventsInput) String() string

String returns the string representation

func (*DescribeEventsInput) Validate 

func (s *DescribeEventsInput) Validate() error

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

type DescribeEventsOutput 

type DescribeEventsOutput struct {

	// Detailed information about one or more events.
	Events []Event `locationNameList:"Event" type:"list"`

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

Represents the output of DescribeEvents. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/EventsMessage

func (DescribeEventsOutput) String 

func (s DescribeEventsOutput) String() string

String returns the string representation

type DescribeEventsPaginator added in v0.9.0 

type DescribeEventsPaginator struct {
	aws.Pager
}

DescribeEventsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeEventsPaginator added in v0.9.0 

func NewDescribeEventsPaginator(req DescribeEventsRequest) DescribeEventsPaginator

NewDescribeEventsRequestPaginator returns a paginator for DescribeEvents. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.DescribeEventsRequest(input)
p := docdb.NewDescribeEventsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeEventsPaginator) CurrentPage added in v0.9.0 

func (p *DescribeEventsPaginator) CurrentPage() *DescribeEventsOutput

type DescribeEventsRequest 

type DescribeEventsRequest struct {
	*aws.Request
	Input *DescribeEventsInput
	Copy  func(*DescribeEventsInput) DescribeEventsRequest
}

DescribeEventsRequest is the request type for the DescribeEvents API operation.

func (DescribeEventsRequest) Send 

func (r DescribeEventsRequest) Send(ctx context.Context) (*DescribeEventsResponse, error)

Send marshals and sends the DescribeEvents API request.

type DescribeEventsResponse added in v0.9.0 

type DescribeEventsResponse struct {
	*DescribeEventsOutput
	// contains filtered or unexported fields
}

DescribeEventsResponse is the response type for the DescribeEvents API operation.

func (*DescribeEventsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeEventsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeEvents request.

type DescribeOrderableDBInstanceOptionsInput 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribeOrderableDBInstanceOptionsMessage

func (DescribeOrderableDBInstanceOptionsInput) String 

func (s DescribeOrderableDBInstanceOptionsInput) String() string

String returns the string representation

func (*DescribeOrderableDBInstanceOptionsInput) Validate 

func (s *DescribeOrderableDBInstanceOptionsInput) Validate() error

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

type DescribeOrderableDBInstanceOptionsOutput 

type DescribeOrderableDBInstanceOptionsOutput struct {

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

	// The options that are available for a particular orderable DB instance.
	OrderableDBInstanceOptions []OrderableDBInstanceOption `locationNameList:"OrderableDBInstanceOption" type:"list"`
	// contains filtered or unexported fields
}

Represents the output of DescribeOrderableDBInstanceOptions. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/OrderableDBInstanceOptionsMessage

func (DescribeOrderableDBInstanceOptionsOutput) String 

func (s DescribeOrderableDBInstanceOptionsOutput) String() string

String returns the string representation

type DescribeOrderableDBInstanceOptionsPaginator added in v0.9.0 

type DescribeOrderableDBInstanceOptionsPaginator struct {
	aws.Pager
}

DescribeOrderableDBInstanceOptionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeOrderableDBInstanceOptionsPaginator added in v0.9.0 

func NewDescribeOrderableDBInstanceOptionsPaginator(req DescribeOrderableDBInstanceOptionsRequest) DescribeOrderableDBInstanceOptionsPaginator

NewDescribeOrderableDBInstanceOptionsRequestPaginator returns a paginator for DescribeOrderableDBInstanceOptions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

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

// Example iterating over pages.
req := client.DescribeOrderableDBInstanceOptionsRequest(input)
p := docdb.NewDescribeOrderableDBInstanceOptionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeOrderableDBInstanceOptionsPaginator) CurrentPage added in v0.9.0 

func (p *DescribeOrderableDBInstanceOptionsPaginator) CurrentPage() *DescribeOrderableDBInstanceOptionsOutput

type DescribeOrderableDBInstanceOptionsRequest 

type DescribeOrderableDBInstanceOptionsRequest struct {
	*aws.Request
	Input *DescribeOrderableDBInstanceOptionsInput
	Copy  func(*DescribeOrderableDBInstanceOptionsInput) DescribeOrderableDBInstanceOptionsRequest
}

DescribeOrderableDBInstanceOptionsRequest is the request type for the DescribeOrderableDBInstanceOptions API operation.

func (DescribeOrderableDBInstanceOptionsRequest) Send 

func (r DescribeOrderableDBInstanceOptionsRequest) Send(ctx context.Context) (*DescribeOrderableDBInstanceOptionsResponse, error)

Send marshals and sends the DescribeOrderableDBInstanceOptions API request.

type DescribeOrderableDBInstanceOptionsResponse added in v0.9.0 

type DescribeOrderableDBInstanceOptionsResponse struct {
	*DescribeOrderableDBInstanceOptionsOutput
	// contains filtered or unexported fields
}

DescribeOrderableDBInstanceOptionsResponse is the response type for the DescribeOrderableDBInstanceOptions API operation.

func (*DescribeOrderableDBInstanceOptionsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeOrderableDBInstanceOptionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeOrderableDBInstanceOptions request.

type DescribePendingMaintenanceActionsInput 

type DescribePendingMaintenanceActionsInput struct {

	// A filter that specifies one or more resources to return pending maintenance
	// actions for.
	//
	// Supported filters:
	//
	//    * db-cluster-id - Accepts 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DescribePendingMaintenanceActionsMessage

func (DescribePendingMaintenanceActionsInput) String 

func (s DescribePendingMaintenanceActionsInput) String() string

String returns the string representation

func (*DescribePendingMaintenanceActionsInput) Validate 

func (s *DescribePendingMaintenanceActionsInput) Validate() error

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

type DescribePendingMaintenanceActionsOutput 

type DescribePendingMaintenanceActionsOutput struct {

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

	// The maintenance actions to be applied.
	PendingMaintenanceActions []ResourcePendingMaintenanceActions `locationNameList:"ResourcePendingMaintenanceActions" type:"list"`
	// contains filtered or unexported fields
}

Represents the output of DescribePendingMaintenanceActions. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/PendingMaintenanceActionsMessage

func (DescribePendingMaintenanceActionsOutput) String 

func (s DescribePendingMaintenanceActionsOutput) String() string

String returns the string representation

type DescribePendingMaintenanceActionsRequest 

type DescribePendingMaintenanceActionsRequest struct {
	*aws.Request
	Input *DescribePendingMaintenanceActionsInput
	Copy  func(*DescribePendingMaintenanceActionsInput) DescribePendingMaintenanceActionsRequest
}

DescribePendingMaintenanceActionsRequest is the request type for the DescribePendingMaintenanceActions API operation.

func (DescribePendingMaintenanceActionsRequest) Send 

func (r DescribePendingMaintenanceActionsRequest) Send(ctx context.Context) (*DescribePendingMaintenanceActionsResponse, error)

Send marshals and sends the DescribePendingMaintenanceActions API request.

type DescribePendingMaintenanceActionsResponse added in v0.9.0 

type DescribePendingMaintenanceActionsResponse struct {
	*DescribePendingMaintenanceActionsOutput
	// contains filtered or unexported fields
}

DescribePendingMaintenanceActionsResponse is the response type for the DescribePendingMaintenanceActions API operation.

func (*DescribePendingMaintenanceActionsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribePendingMaintenanceActionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribePendingMaintenanceActions request.

type Endpoint 

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/Endpoint

func (Endpoint) String 

func (s Endpoint) String() string

String returns the string representation

type EngineDefaults 

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

Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/EngineDefaults

func (EngineDefaults) String 

func (s EngineDefaults) String() string

String returns the string representation

type Event 

type Event struct {

	// Specifies the date and time of the event.
	Date *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// Specifies the category for the event.
	EventCategories []string `locationNameList:"EventCategory" type:"list"`

	// Provides the text of this event.
	Message *string `type:"string"`

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

	// Provides the identifier for the source of the event.
	SourceIdentifier *string `type:"string"`

	// Specifies the source type for this event.
	SourceType SourceType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Detailed information about an event. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/Event

func (Event) String 

func (s Event) String() string

String returns the string representation

type EventCategoriesMap 

type EventCategoriesMap struct {

	// The event categories for the specified source type.
	EventCategories []string `locationNameList:"EventCategory" type:"list"`

	// The source type that the returned categories belong to.
	SourceType *string `type:"string"`
	// contains filtered or unexported fields
}

An event source type, accompanied by one or more event category names. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/EventCategoriesMap

func (EventCategoriesMap) String 

func (s EventCategoriesMap) String() string

String returns the string representation

type FailoverDBClusterInput 

type FailoverDBClusterInput struct {

	// A DB cluster identifier to force a failover for. This parameter is not case
	// sensitive.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBCluster.
	DBClusterIdentifier *string `type:"string"`

	// The name of the instance to promote to the primary instance.
	//
	// You must specify the instance identifier for an Amazon DocumentDB replica
	// in the DB cluster. For example, mydbcluster-replica1.
	TargetDBInstanceIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the input to FailoverDBCluster. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/FailoverDBClusterMessage

func (FailoverDBClusterInput) String 

func (s FailoverDBClusterInput) String() string

String returns the string representation

type FailoverDBClusterOutput 

type FailoverDBClusterOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/FailoverDBClusterResult

func (FailoverDBClusterOutput) String 

func (s FailoverDBClusterOutput) String() string

String returns the string representation

type FailoverDBClusterRequest 

type FailoverDBClusterRequest struct {
	*aws.Request
	Input *FailoverDBClusterInput
	Copy  func(*FailoverDBClusterInput) FailoverDBClusterRequest
}

FailoverDBClusterRequest is the request type for the FailoverDBCluster API operation.

func (FailoverDBClusterRequest) Send 

func (r FailoverDBClusterRequest) Send(ctx context.Context) (*FailoverDBClusterResponse, error)

Send marshals and sends the FailoverDBCluster API request.

type FailoverDBClusterResponse added in v0.9.0 

type FailoverDBClusterResponse struct {
	*FailoverDBClusterOutput
	// contains filtered or unexported fields
}

FailoverDBClusterResponse is the response type for the FailoverDBCluster API operation.

func (*FailoverDBClusterResponse) SDKResponseMetdata added in v0.9.0 

func (r *FailoverDBClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the FailoverDBCluster request.

type Filter 

type Filter struct {

	// The name of the filter. Filter names are case sensitive.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// One or more filter values. Filter values are case sensitive.
	//
	// Values is a required field
	Values []string `locationNameList:"Value" type:"list" required:"true"`
	// contains filtered or unexported fields
}

A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

Wildcards are not supported in filters. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/Filter

func (Filter) String 

func (s Filter) String() string

String returns the string representation

func (*Filter) Validate 

func (s *Filter) Validate() error

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

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

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

	// The Amazon DocumentDB resource with tags to be listed. This value is an Amazon
	// Resource Name (ARN).
	//
	// ResourceName is a required field
	ResourceName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to ListTagsForResource. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ListTagsForResourceMessage

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// A list of one or more tags.
	TagList []Tag `locationNameList:"Tag" type:"list"`
	// contains filtered or unexported fields
}

Represents the output of ListTagsForResource. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/TagListMessage

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.9.0 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type ModifyDBClusterInput 

type ModifyDBClusterInput struct {

	// A value that specifies whether the changes in this request and any pending
	// changes are asynchronously applied as soon as possible, regardless of the
	// PreferredMaintenanceWindow setting for the DB cluster. If this parameter
	// is set to false, changes to the DB cluster are applied during the next maintenance
	// window.
	//
	// The ApplyImmediately parameter affects only the NewDBClusterIdentifier and
	// MasterUserPassword values. If you set this parameter value to false, the
	// changes to the NewDBClusterIdentifier and MasterUserPassword values are applied
	// during the next maintenance window. All other changes are applied immediately,
	// regardless of the value of the ApplyImmediately parameter.
	//
	// Default: false
	ApplyImmediately *bool `type:"boolean"`

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

	// The configuration setting for the log types to be enabled for export to Amazon
	// CloudWatch Logs for a specific DB instance or DB cluster. The EnableLogTypes
	// and DisableLogTypes arrays determine which logs are exported (or not exported)
	// to CloudWatch Logs.
	CloudwatchLogsExportConfiguration *CloudwatchLogsExportConfiguration `type:"structure"`

	// The DB cluster identifier for the cluster that is being modified. This parameter
	// is not case sensitive.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBCluster.
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The name of the DB cluster parameter group to use for the DB cluster.
	DBClusterParameterGroupName *string `type:"string"`

	// The version number of the database engine to which you want to upgrade. Changing
	// this parameter results in an outage. The change is applied during the next
	// maintenance window unless the ApplyImmediately parameter is set to true.
	EngineVersion *string `type:"string"`

	// The new password for the master database user. This password can contain
	// any printable ASCII character except "/", """, or "@".
	//
	// Constraints: Must contain from 8 to 41 characters.
	MasterUserPassword *string `type:"string"`

	// The new DB cluster identifier for the DB cluster when renaming a DB cluster.
	// This value is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens.
	//
	//    * The first character must be a letter.
	//
	//    * Cannot end with a hyphen or contain two consecutive hyphens.
	//
	// Example: my-cluster2
	NewDBClusterIdentifier *string `type:"string"`

	// The port number on which the DB cluster accepts connections.
	//
	// Constraints: Must be a value from 1150 to 65535.
	//
	// Default: The same port as the original DB cluster.
	Port *int64 `type:"integer"`

	// The daily time range during which automated backups are created if automated
	// backups are enabled, using the BackupRetentionPeriod parameter.
	//
	// The default is a 30-minute window selected at random from an 8-hour block
	// of time for each 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"`

	// A list of virtual private cloud (VPC) security groups that the DB cluster
	// will belong to.
	VpcSecurityGroupIds []string `locationNameList:"VpcSecurityGroupId" type:"list"`
	// contains filtered or unexported fields
}

Represents the input to ModifyDBCluster. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterMessage

func (ModifyDBClusterInput) String 

func (s ModifyDBClusterInput) String() string

String returns the string representation

func (*ModifyDBClusterInput) Validate 

func (s *ModifyDBClusterInput) Validate() error

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

type ModifyDBClusterOutput 

type ModifyDBClusterOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterResult

func (ModifyDBClusterOutput) String 

func (s ModifyDBClusterOutput) String() string

String returns the string representation

type ModifyDBClusterParameterGroupInput 

type ModifyDBClusterParameterGroupInput struct {

	// The name of the DB cluster parameter group to modify.
	//
	// DBClusterParameterGroupName is a required field
	DBClusterParameterGroupName *string `type:"string" required:"true"`

	// A list of parameters in the DB cluster parameter group to modify.
	//
	// Parameters is a required field
	Parameters []Parameter `locationNameList:"Parameter" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to ModifyDBClusterParameterGroup. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterParameterGroupMessage

func (ModifyDBClusterParameterGroupInput) String 

func (s ModifyDBClusterParameterGroupInput) String() string

String returns the string representation

func (*ModifyDBClusterParameterGroupInput) Validate 

func (s *ModifyDBClusterParameterGroupInput) Validate() error

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

type ModifyDBClusterParameterGroupOutput added in v0.9.0 

type ModifyDBClusterParameterGroupOutput struct {

	// The name of a DB cluster parameter group.
	//
	// Constraints:
	//
	//    * Must be from 1 to 255 letters or numbers.
	//
	//    * The first character must be a letter.
	//
	//    * Cannot end with a hyphen or contain two consecutive hyphens.
	//
	// This value is stored as a lowercase string.
	DBClusterParameterGroupName *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the name of a DB cluster parameter group. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterParameterGroupNameMessage

func (ModifyDBClusterParameterGroupOutput) String added in v0.9.0 

func (s ModifyDBClusterParameterGroupOutput) String() string

String returns the string representation

type ModifyDBClusterParameterGroupRequest 

type ModifyDBClusterParameterGroupRequest struct {
	*aws.Request
	Input *ModifyDBClusterParameterGroupInput
	Copy  func(*ModifyDBClusterParameterGroupInput) ModifyDBClusterParameterGroupRequest
}

ModifyDBClusterParameterGroupRequest is the request type for the ModifyDBClusterParameterGroup API operation.

func (ModifyDBClusterParameterGroupRequest) Send 

func (r ModifyDBClusterParameterGroupRequest) Send(ctx context.Context) (*ModifyDBClusterParameterGroupResponse, error)

Send marshals and sends the ModifyDBClusterParameterGroup API request.

type ModifyDBClusterParameterGroupResponse added in v0.9.0 

type ModifyDBClusterParameterGroupResponse struct {
	*ModifyDBClusterParameterGroupOutput
	// contains filtered or unexported fields
}

ModifyDBClusterParameterGroupResponse is the response type for the ModifyDBClusterParameterGroup API operation.

func (*ModifyDBClusterParameterGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *ModifyDBClusterParameterGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ModifyDBClusterParameterGroup request.

type ModifyDBClusterRequest 

type ModifyDBClusterRequest struct {
	*aws.Request
	Input *ModifyDBClusterInput
	Copy  func(*ModifyDBClusterInput) ModifyDBClusterRequest
}

ModifyDBClusterRequest is the request type for the ModifyDBCluster API operation.

func (ModifyDBClusterRequest) Send 

func (r ModifyDBClusterRequest) Send(ctx context.Context) (*ModifyDBClusterResponse, error)

Send marshals and sends the ModifyDBCluster API request.

type ModifyDBClusterResponse added in v0.9.0 

type ModifyDBClusterResponse struct {
	*ModifyDBClusterOutput
	// contains filtered or unexported fields
}

ModifyDBClusterResponse is the response type for the ModifyDBCluster API operation.

func (*ModifyDBClusterResponse) SDKResponseMetdata added in v0.9.0 

func (r *ModifyDBClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ModifyDBCluster request.

type ModifyDBClusterSnapshotAttributeInput 

type ModifyDBClusterSnapshotAttributeInput struct {

	// The name of the DB cluster snapshot attribute to modify.
	//
	// To manage authorization for other AWS accounts to copy or restore a manual
	// DB cluster snapshot, set this value to restore.
	//
	// AttributeName is a required field
	AttributeName *string `type:"string" required:"true"`

	// The identifier for the DB cluster snapshot to modify the attributes for.
	//
	// DBClusterSnapshotIdentifier is a required field
	DBClusterSnapshotIdentifier *string `type:"string" required:"true"`

	// A list of DB cluster snapshot attributes to add to the attribute specified
	// by AttributeName.
	//
	// To authorize other AWS accounts to copy or restore a manual DB cluster snapshot,
	// set this list to include one or more AWS account IDs. To make the manual
	// DB cluster snapshot restorable by any AWS account, set it to all. Do not
	// add the all value for any manual DB cluster snapshots that contain private
	// information that you don't want to be available to all AWS accounts.
	ValuesToAdd []string `locationNameList:"AttributeValue" type:"list"`

	// A list of DB cluster snapshot attributes to remove from the attribute specified
	// by AttributeName.
	//
	// To remove authorization for other AWS accounts to copy or restore a manual
	// DB cluster snapshot, set this list to include one or more AWS account identifiers.
	// To remove authorization for any AWS account to copy or restore the DB cluster
	// snapshot, set it to all . If you specify all, an AWS account whose account
	// ID is explicitly added to the restore attribute can still copy or restore
	// a manual DB cluster snapshot.
	ValuesToRemove []string `locationNameList:"AttributeValue" type:"list"`
	// contains filtered or unexported fields
}

Represents the input to ModifyDBClusterSnapshotAttribute. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterSnapshotAttributeMessage

func (ModifyDBClusterSnapshotAttributeInput) String 

func (s ModifyDBClusterSnapshotAttributeInput) String() string

String returns the string representation

func (*ModifyDBClusterSnapshotAttributeInput) Validate 

func (s *ModifyDBClusterSnapshotAttributeInput) Validate() error

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

type ModifyDBClusterSnapshotAttributeOutput 

type ModifyDBClusterSnapshotAttributeOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBClusterSnapshotAttributeResult

func (ModifyDBClusterSnapshotAttributeOutput) String 

func (s ModifyDBClusterSnapshotAttributeOutput) String() string

String returns the string representation

type ModifyDBClusterSnapshotAttributeRequest 

type ModifyDBClusterSnapshotAttributeRequest struct {
	*aws.Request
	Input *ModifyDBClusterSnapshotAttributeInput
	Copy  func(*ModifyDBClusterSnapshotAttributeInput) ModifyDBClusterSnapshotAttributeRequest
}

ModifyDBClusterSnapshotAttributeRequest is the request type for the ModifyDBClusterSnapshotAttribute API operation.

func (ModifyDBClusterSnapshotAttributeRequest) Send 

func (r ModifyDBClusterSnapshotAttributeRequest) Send(ctx context.Context) (*ModifyDBClusterSnapshotAttributeResponse, error)

Send marshals and sends the ModifyDBClusterSnapshotAttribute API request.

type ModifyDBClusterSnapshotAttributeResponse added in v0.9.0 

type ModifyDBClusterSnapshotAttributeResponse struct {
	*ModifyDBClusterSnapshotAttributeOutput
	// contains filtered or unexported fields
}

ModifyDBClusterSnapshotAttributeResponse is the response type for the ModifyDBClusterSnapshotAttribute API operation.

func (*ModifyDBClusterSnapshotAttributeResponse) SDKResponseMetdata added in v0.9.0 

func (r *ModifyDBClusterSnapshotAttributeResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ModifyDBClusterSnapshotAttribute request.

type ModifyDBInstanceInput 

type ModifyDBInstanceInput struct {

	// Specifies whether the modifications in this request and any pending modifications
	// are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow
	// setting for the DB instance.
	//
	// If this parameter is set to false, changes to the DB instance are applied
	// during the next maintenance window. Some parameter changes can cause an outage
	// and are applied on the next reboot.
	//
	// Default: false
	ApplyImmediately *bool `type:"boolean"`

	// Indicates that minor version upgrades are applied automatically to the DB
	// instance during the maintenance window. Changing this parameter doesn't result
	// in an outage except in the following case, and the change is asynchronously
	// applied as soon as possible. An outage results if this parameter is set to
	// true during the maintenance window, and a newer minor version is available,
	// and Amazon DocumentDB has enabled automatic patching for that engine version.
	AutoMinorVersionUpgrade *bool `type:"boolean"`

	// The new compute and memory capacity of the DB instance; for example, db.m4.large.
	// Not all DB instance classes are available in all AWS Regions.
	//
	// If you modify the DB instance class, an outage occurs during the change.
	// The change is applied during the next maintenance window, unless ApplyImmediately
	// is specified as true for this request.
	//
	// Default: Uses existing setting.
	DBInstanceClass *string `type:"string"`

	// The DB instance identifier. This value is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBInstance.
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// The new DB instance identifier for the DB instance when renaming a DB instance.
	// When you change the DB instance identifier, an instance reboot occurs immediately
	// if you set Apply Immediately to true. It occurs during the next maintenance
	// window if you set Apply Immediately to false. This value is stored as a lowercase
	// string.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens.
	//
	//    * The first character must be a letter.
	//
	//    * Cannot end with a hyphen or contain two consecutive hyphens.
	//
	// Example: mydbinstance
	NewDBInstanceIdentifier *string `type:"string"`

	// The weekly time range (in UTC) during which system maintenance can occur,
	// which might result in an outage. Changing this parameter doesn't result in
	// an outage except in the following situation, and the change is asynchronously
	// applied as soon as possible. If there are pending actions that cause a reboot,
	// and the maintenance window is changed to include the current time, changing
	// this parameter causes a reboot of the DB instance. If you are moving this
	// window to the current time, there must be at least 30 minutes between the
	// current time and end of the window to ensure that pending changes are applied.
	//
	// Default: Uses existing setting.
	//
	// Format: ddd:hh24:mi-ddd:hh24:mi
	//
	// Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
	//
	// Constraints: Must be at least 30 minutes.
	PreferredMaintenanceWindow *string `type:"string"`

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

Represents the input to ModifyDBInstance. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBInstanceMessage

func (ModifyDBInstanceInput) String 

func (s ModifyDBInstanceInput) String() string

String returns the string representation

func (*ModifyDBInstanceInput) Validate 

func (s *ModifyDBInstanceInput) Validate() error

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

type ModifyDBInstanceOutput 

type ModifyDBInstanceOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBInstanceResult

func (ModifyDBInstanceOutput) String 

func (s ModifyDBInstanceOutput) String() string

String returns the string representation

type ModifyDBInstanceRequest 

type ModifyDBInstanceRequest struct {
	*aws.Request
	Input *ModifyDBInstanceInput
	Copy  func(*ModifyDBInstanceInput) ModifyDBInstanceRequest
}

ModifyDBInstanceRequest is the request type for the ModifyDBInstance API operation.

func (ModifyDBInstanceRequest) Send 

func (r ModifyDBInstanceRequest) Send(ctx context.Context) (*ModifyDBInstanceResponse, error)

Send marshals and sends the ModifyDBInstance API request.

type ModifyDBInstanceResponse added in v0.9.0 

type ModifyDBInstanceResponse struct {
	*ModifyDBInstanceOutput
	// contains filtered or unexported fields
}

ModifyDBInstanceResponse is the response type for the ModifyDBInstance API operation.

func (*ModifyDBInstanceResponse) SDKResponseMetdata added in v0.9.0 

func (r *ModifyDBInstanceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ModifyDBInstance request.

type ModifyDBSubnetGroupInput 

type ModifyDBSubnetGroupInput struct {

	// The description for the DB subnet group.
	DBSubnetGroupDescription *string `type:"string"`

	// The name for the DB subnet group. This value is stored as a lowercase string.
	// You can't modify the default subnet group.
	//
	// Constraints: Must match the name of an existing DBSubnetGroup. Must not be
	// default.
	//
	// Example: mySubnetgroup
	//
	// DBSubnetGroupName is a required field
	DBSubnetGroupName *string `type:"string" required:"true"`

	// The Amazon EC2 subnet IDs for the DB subnet group.
	//
	// SubnetIds is a required field
	SubnetIds []string `locationNameList:"SubnetIdentifier" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to ModifyDBSubnetGroup. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBSubnetGroupMessage

func (ModifyDBSubnetGroupInput) String 

func (s ModifyDBSubnetGroupInput) String() string

String returns the string representation

func (*ModifyDBSubnetGroupInput) Validate 

func (s *ModifyDBSubnetGroupInput) Validate() error

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

type ModifyDBSubnetGroupOutput 

type ModifyDBSubnetGroupOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ModifyDBSubnetGroupResult

func (ModifyDBSubnetGroupOutput) String 

func (s ModifyDBSubnetGroupOutput) String() string

String returns the string representation

type ModifyDBSubnetGroupRequest 

type ModifyDBSubnetGroupRequest struct {
	*aws.Request
	Input *ModifyDBSubnetGroupInput
	Copy  func(*ModifyDBSubnetGroupInput) ModifyDBSubnetGroupRequest
}

ModifyDBSubnetGroupRequest is the request type for the ModifyDBSubnetGroup API operation.

func (ModifyDBSubnetGroupRequest) Send 

func (r ModifyDBSubnetGroupRequest) Send(ctx context.Context) (*ModifyDBSubnetGroupResponse, error)

Send marshals and sends the ModifyDBSubnetGroup API request.

type ModifyDBSubnetGroupResponse added in v0.9.0 

type ModifyDBSubnetGroupResponse struct {
	*ModifyDBSubnetGroupOutput
	// contains filtered or unexported fields
}

ModifyDBSubnetGroupResponse is the response type for the ModifyDBSubnetGroup API operation.

func (*ModifyDBSubnetGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *ModifyDBSubnetGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ModifyDBSubnetGroup request.

type OrderableDBInstanceOption 

type OrderableDBInstanceOption struct {

	// A list of Availability Zones for a DB instance.
	AvailabilityZones []AvailabilityZone `locationNameList:"AvailabilityZone" type:"list"`

	// The DB instance class for a DB instance.
	DBInstanceClass *string `type:"string"`

	// The engine type of a DB instance.
	Engine *string `type:"string"`

	// The engine version of a DB instance.
	EngineVersion *string `type:"string"`

	// The license model for a DB instance.
	LicenseModel *string `type:"string"`

	// Indicates whether a DB instance is in a virtual private cloud (VPC).
	Vpc *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The options that are available for a DB instance. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/OrderableDBInstanceOption

func (OrderableDBInstanceOption) String 

func (s OrderableDBInstanceOption) String() string

String returns the string representation

type Parameter 

type Parameter struct {

	// Specifies the valid range of values for the parameter.
	AllowedValues *string `type:"string"`

	// Indicates when to apply parameter updates.
	ApplyMethod ApplyMethod `type:"string" enum:"true"`

	// Specifies the engine-specific parameters type.
	ApplyType *string `type:"string"`

	// Specifies the valid data type for the parameter.
	DataType *string `type:"string"`

	// Provides a description of the parameter.
	Description *string `type:"string"`

	// Indicates whether (true) or not (false) the parameter can be modified. Some
	// parameters have security or operational implications that prevent them from
	// being changed.
	IsModifiable *bool `type:"boolean"`

	// The earliest engine version to which the parameter can apply.
	MinimumEngineVersion *string `type:"string"`

	// Specifies the name of the parameter.
	ParameterName *string `type:"string"`

	// Specifies the value of the parameter.
	ParameterValue *string `type:"string"`

	// Indicates the source of the parameter value.
	Source *string `type:"string"`
	// contains filtered or unexported fields
}

Detailed information about an individual parameter. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/Parameter

func (Parameter) String 

func (s Parameter) String() string

String returns the string representation

type PendingCloudwatchLogsExports 

type PendingCloudwatchLogsExports struct {

	// Log types that are in the process of being enabled. After they are enabled,
	// these log types are exported to Amazon CloudWatch Logs.
	LogTypesToDisable []string `type:"list"`

	// Log types that are in the process of being deactivated. After they are deactivated,
	// these log types aren't exported to CloudWatch Logs.
	LogTypesToEnable []string `type:"list"`
	// contains filtered or unexported fields
}

A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/PendingCloudwatchLogsExports

func (PendingCloudwatchLogsExports) String 

func (s PendingCloudwatchLogsExports) String() string

String returns the string representation

type PendingMaintenanceAction 

type PendingMaintenanceAction struct {

	// The type of pending maintenance action that is available for the resource.
	Action *string `type:"string"`

	// The date of the maintenance window when the action is applied. The maintenance
	// action is applied to the resource during its first maintenance window after
	// this date. If this date is specified, any next-maintenance opt-in requests
	// are ignored.
	AutoAppliedAfterDate *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The effective date when the pending maintenance action is applied to the
	// resource.
	CurrentApplyDate *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// A description providing more detail about the maintenance action.
	Description *string `type:"string"`

	// The date when the maintenance action is automatically applied. The maintenance
	// action is applied to the resource on this date regardless of the maintenance
	// window for the resource. If this date is specified, any immediate opt-in
	// requests are ignored.
	ForcedApplyDate *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// Indicates the type of opt-in request that has been received for the resource.
	OptInStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Provides information about a pending maintenance action for a resource. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/PendingMaintenanceAction

func (PendingMaintenanceAction) String 

func (s PendingMaintenanceAction) String() string

String returns the string representation

type PendingModifiedValues 

type PendingModifiedValues struct {

	// Contains the new AllocatedStorage size for the DB instance that will be applied
	// or is currently being applied.
	AllocatedStorage *int64 `type:"integer"`

	// Specifies the pending number of days for which automated backups are retained.
	BackupRetentionPeriod *int64 `type:"integer"`

	// Specifies the identifier of the certificate authority (CA) certificate for
	// the DB instance.
	CACertificateIdentifier *string `type:"string"`

	// Contains the new DBInstanceClass for the DB instance that will be applied
	// or is currently being applied.
	DBInstanceClass *string `type:"string"`

	// Contains the new DBInstanceIdentifier for the DB instance that will be applied
	// or is currently being applied.
	DBInstanceIdentifier *string `type:"string"`

	// The new DB subnet group for the DB instance.
	DBSubnetGroupName *string `type:"string"`

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

	// Specifies the new Provisioned IOPS value for the DB instance that will be
	// applied or is currently being applied.
	Iops *int64 `type:"integer"`

	// The license model for the DB instance.
	//
	// Valid values: license-included, bring-your-own-license, general-public-license
	LicenseModel *string `type:"string"`

	// Contains the pending or currently in-progress change of the master credentials
	// for the DB instance.
	MasterUserPassword *string `type:"string"`

	// Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
	MultiAZ *bool `type:"boolean"`

	// A list of the log types whose configuration is still pending. These log types
	// are in the process of being activated or deactivated.
	PendingCloudwatchLogsExports *PendingCloudwatchLogsExports `type:"structure"`

	// Specifies the pending port for the DB instance.
	Port *int64 `type:"integer"`

	// Specifies the storage type to be associated with the DB instance.
	StorageType *string `type:"string"`
	// contains filtered or unexported fields
}

One or more modified settings for a DB instance. These modified settings have been requested, but haven't been applied yet. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/PendingModifiedValues

func (PendingModifiedValues) String 

func (s PendingModifiedValues) String() string

String returns the string representation

type RebootDBInstanceInput 

type RebootDBInstanceInput struct {

	// The DB instance identifier. This parameter is stored as a lowercase string.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBInstance.
	//
	// DBInstanceIdentifier is a required field
	DBInstanceIdentifier *string `type:"string" required:"true"`

	// When true, the reboot is conducted through a Multi-AZ failover.
	//
	// Constraint: You can't specify true if the instance is not configured for
	// Multi-AZ.
	ForceFailover *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Represents the input to RebootDBInstance. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RebootDBInstanceMessage

func (RebootDBInstanceInput) String 

func (s RebootDBInstanceInput) String() string

String returns the string representation

func (*RebootDBInstanceInput) Validate 

func (s *RebootDBInstanceInput) Validate() error

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

type RebootDBInstanceOutput 

type RebootDBInstanceOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RebootDBInstanceResult

func (RebootDBInstanceOutput) String 

func (s RebootDBInstanceOutput) String() string

String returns the string representation

type RebootDBInstanceRequest 

type RebootDBInstanceRequest struct {
	*aws.Request
	Input *RebootDBInstanceInput
	Copy  func(*RebootDBInstanceInput) RebootDBInstanceRequest
}

RebootDBInstanceRequest is the request type for the RebootDBInstance API operation.

func (RebootDBInstanceRequest) Send 

func (r RebootDBInstanceRequest) Send(ctx context.Context) (*RebootDBInstanceResponse, error)

Send marshals and sends the RebootDBInstance API request.

type RebootDBInstanceResponse added in v0.9.0 

type RebootDBInstanceResponse struct {
	*RebootDBInstanceOutput
	// contains filtered or unexported fields
}

RebootDBInstanceResponse is the response type for the RebootDBInstance API operation.

func (*RebootDBInstanceResponse) SDKResponseMetdata added in v0.9.0 

func (r *RebootDBInstanceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RebootDBInstance request.

type RemoveTagsFromResourceInput 

type RemoveTagsFromResourceInput struct {

	// The Amazon DocumentDB resource that the tags are removed from. This value
	// is an Amazon Resource Name (ARN).
	//
	// ResourceName is a required field
	ResourceName *string `type:"string" required:"true"`

	// The tag key (name) of the tag to be removed.
	//
	// TagKeys is a required field
	TagKeys []string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the input to RemoveTagsFromResource. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveTagsFromResourceMessage

func (RemoveTagsFromResourceInput) String 

func (s RemoveTagsFromResourceInput) String() string

String returns the string representation

func (*RemoveTagsFromResourceInput) Validate 

func (s *RemoveTagsFromResourceInput) Validate() error

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

type RemoveTagsFromResourceOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RemoveTagsFromResourceOutput

func (RemoveTagsFromResourceOutput) String 

func (s RemoveTagsFromResourceOutput) String() string

String returns the string representation

type RemoveTagsFromResourceRequest 

type RemoveTagsFromResourceRequest struct {
	*aws.Request
	Input *RemoveTagsFromResourceInput
	Copy  func(*RemoveTagsFromResourceInput) RemoveTagsFromResourceRequest
}

RemoveTagsFromResourceRequest is the request type for the RemoveTagsFromResource API operation.

func (RemoveTagsFromResourceRequest) Send 

func (r RemoveTagsFromResourceRequest) Send(ctx context.Context) (*RemoveTagsFromResourceResponse, error)

Send marshals and sends the RemoveTagsFromResource API request.

type RemoveTagsFromResourceResponse added in v0.9.0 

type RemoveTagsFromResourceResponse struct {
	*RemoveTagsFromResourceOutput
	// contains filtered or unexported fields
}

RemoveTagsFromResourceResponse is the response type for the RemoveTagsFromResource API operation.

func (*RemoveTagsFromResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *RemoveTagsFromResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RemoveTagsFromResource request.

type ResetDBClusterParameterGroupInput 

type ResetDBClusterParameterGroupInput struct {

	// The name of the DB cluster parameter group to reset.
	//
	// DBClusterParameterGroupName is a required field
	DBClusterParameterGroupName *string `type:"string" required:"true"`

	// A list of parameter names in the DB cluster parameter group to reset to the
	// default values. You can't use this parameter if the ResetAllParameters parameter
	// is set to true.
	Parameters []Parameter `locationNameList:"Parameter" type:"list"`

	// A value that is set to true to reset all parameters in the DB cluster parameter
	// group to their default values, and false otherwise. You can't use this parameter
	// if there is a list of parameter names specified for the Parameters parameter.
	ResetAllParameters *bool `type:"boolean"`
	// contains filtered or unexported fields
}

Represents the input to ResetDBClusterParameterGroup. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ResetDBClusterParameterGroupMessage

func (ResetDBClusterParameterGroupInput) String 

func (s ResetDBClusterParameterGroupInput) String() string

String returns the string representation

func (*ResetDBClusterParameterGroupInput) Validate 

func (s *ResetDBClusterParameterGroupInput) Validate() error

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

type ResetDBClusterParameterGroupOutput 

type ResetDBClusterParameterGroupOutput struct {

	// The name of a DB cluster parameter group.
	//
	// Constraints:
	//
	//    * Must be from 1 to 255 letters or numbers.
	//
	//    * The first character must be a letter.
	//
	//    * Cannot end with a hyphen or contain two consecutive hyphens.
	//
	// This value is stored as a lowercase string.
	DBClusterParameterGroupName *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the name of a DB cluster parameter group. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBClusterParameterGroupNameMessage

func (ResetDBClusterParameterGroupOutput) String 

func (s ResetDBClusterParameterGroupOutput) String() string

String returns the string representation

type ResetDBClusterParameterGroupRequest 

type ResetDBClusterParameterGroupRequest struct {
	*aws.Request
	Input *ResetDBClusterParameterGroupInput
	Copy  func(*ResetDBClusterParameterGroupInput) ResetDBClusterParameterGroupRequest
}

ResetDBClusterParameterGroupRequest is the request type for the ResetDBClusterParameterGroup API operation.

func (ResetDBClusterParameterGroupRequest) Send 

func (r ResetDBClusterParameterGroupRequest) Send(ctx context.Context) (*ResetDBClusterParameterGroupResponse, error)

Send marshals and sends the ResetDBClusterParameterGroup API request.

type ResetDBClusterParameterGroupResponse added in v0.9.0 

type ResetDBClusterParameterGroupResponse struct {
	*ResetDBClusterParameterGroupOutput
	// contains filtered or unexported fields
}

ResetDBClusterParameterGroupResponse is the response type for the ResetDBClusterParameterGroup API operation.

func (*ResetDBClusterParameterGroupResponse) SDKResponseMetdata added in v0.9.0 

func (r *ResetDBClusterParameterGroupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ResetDBClusterParameterGroup request.

type ResourcePendingMaintenanceActions 

type ResourcePendingMaintenanceActions struct {

	// A list that provides details about the pending maintenance actions for the
	// resource.
	PendingMaintenanceActionDetails []PendingMaintenanceAction `locationNameList:"PendingMaintenanceAction" type:"list"`

	// The Amazon Resource Name (ARN) of the resource that has pending maintenance
	// actions.
	ResourceIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of ApplyPendingMaintenanceAction. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/ResourcePendingMaintenanceActions

func (ResourcePendingMaintenanceActions) String 

func (s ResourcePendingMaintenanceActions) String() string

String returns the string representation

type RestoreDBClusterFromSnapshotInput 

type RestoreDBClusterFromSnapshotInput struct {

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

	// The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.
	// This parameter isn't case sensitive.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens.
	//
	//    * The first character must be a letter.
	//
	//    * Cannot end with a hyphen or contain two consecutive hyphens.
	//
	// Example: my-snapshot-id
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The name of the DB subnet group to use for the new DB cluster.
	//
	// Constraints: If provided, must match the name of an existing DBSubnetGroup.
	//
	// Example: mySubnetgroup
	DBSubnetGroupName *string `type:"string"`

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

	// The database engine to use for the new DB cluster.
	//
	// Default: The same as source.
	//
	// Constraint: Must be compatible with the engine of the source.
	//
	// Engine is a required field
	Engine *string `type:"string" required:"true"`

	// The version of the database engine to use for the new DB cluster.
	EngineVersion *string `type:"string"`

	// The AWS KMS key identifier to use when restoring an encrypted DB cluster
	// from a DB snapshot or DB cluster snapshot.
	//
	// The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS
	// KMS encryption key. If you are restoring a DB cluster with the same AWS account
	// that owns the AWS KMS encryption key used to encrypt the new DB cluster,
	// then you can use the AWS KMS key alias instead of the ARN for the AWS KMS
	// encryption key.
	//
	// If you do not specify a value for the KmsKeyId parameter, then the following
	// occurs:
	//
	//    * If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted,
	//    then the restored DB cluster is encrypted using the AWS KMS key that was
	//    used to encrypt the DB snapshot or the DB cluster snapshot.
	//
	//    * If the DB snapshot or the DB cluster snapshot in SnapshotIdentifier
	//    is not encrypted, then the restored DB cluster is not encrypted.
	KmsKeyId *string `type:"string"`

	// The port number on which the new DB cluster accepts connections.
	//
	// Constraints: Must be a value from 1150 to 65535.
	//
	// Default: The same port as the original DB cluster.
	Port *int64 `type:"integer"`

	// The identifier for the DB snapshot or DB cluster snapshot to restore from.
	//
	// You can use either the name or the Amazon Resource Name (ARN) to specify
	// a DB cluster snapshot. However, you can use only the ARN to specify a DB
	// snapshot.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing snapshot.
	//
	// SnapshotIdentifier is a required field
	SnapshotIdentifier *string `type:"string" required:"true"`

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

	// A list of virtual private cloud (VPC) security groups that the new DB cluster
	// will belong to.
	VpcSecurityGroupIds []string `locationNameList:"VpcSecurityGroupId" type:"list"`
	// contains filtered or unexported fields
}

Represents the input to RestoreDBClusterFromSnapshot. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterFromSnapshotMessage

func (RestoreDBClusterFromSnapshotInput) String 

func (s RestoreDBClusterFromSnapshotInput) String() string

String returns the string representation

func (*RestoreDBClusterFromSnapshotInput) Validate 

func (s *RestoreDBClusterFromSnapshotInput) Validate() error

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

type RestoreDBClusterFromSnapshotOutput 

type RestoreDBClusterFromSnapshotOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterFromSnapshotResult

func (RestoreDBClusterFromSnapshotOutput) String 

func (s RestoreDBClusterFromSnapshotOutput) String() string

String returns the string representation

type RestoreDBClusterFromSnapshotRequest 

type RestoreDBClusterFromSnapshotRequest struct {
	*aws.Request
	Input *RestoreDBClusterFromSnapshotInput
	Copy  func(*RestoreDBClusterFromSnapshotInput) RestoreDBClusterFromSnapshotRequest
}

RestoreDBClusterFromSnapshotRequest is the request type for the RestoreDBClusterFromSnapshot API operation.

func (RestoreDBClusterFromSnapshotRequest) Send 

func (r RestoreDBClusterFromSnapshotRequest) Send(ctx context.Context) (*RestoreDBClusterFromSnapshotResponse, error)

Send marshals and sends the RestoreDBClusterFromSnapshot API request.

type RestoreDBClusterFromSnapshotResponse added in v0.9.0 

type RestoreDBClusterFromSnapshotResponse struct {
	*RestoreDBClusterFromSnapshotOutput
	// contains filtered or unexported fields
}

RestoreDBClusterFromSnapshotResponse is the response type for the RestoreDBClusterFromSnapshot API operation.

func (*RestoreDBClusterFromSnapshotResponse) SDKResponseMetdata added in v0.9.0 

func (r *RestoreDBClusterFromSnapshotResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RestoreDBClusterFromSnapshot request.

type RestoreDBClusterToPointInTimeInput 

type RestoreDBClusterToPointInTimeInput struct {

	// The name of the new DB cluster to be created.
	//
	// Constraints:
	//
	//    * Must contain from 1 to 63 letters, numbers, or hyphens.
	//
	//    * The first character must be a letter.
	//
	//    * Cannot end with a hyphen or contain two consecutive hyphens.
	//
	// DBClusterIdentifier is a required field
	DBClusterIdentifier *string `type:"string" required:"true"`

	// The DB subnet group name to use for the new DB cluster.
	//
	// Constraints: If provided, must match the name of an existing DBSubnetGroup.
	//
	// Example: mySubnetgroup
	DBSubnetGroupName *string `type:"string"`

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

	// The AWS KMS key identifier to use when restoring an encrypted DB cluster
	// from an encrypted DB cluster.
	//
	// The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS
	// KMS encryption key. If you are restoring a DB cluster with the same AWS account
	// that owns the AWS KMS encryption key used to encrypt the new DB cluster,
	// then you can use the AWS KMS key alias instead of the ARN for the AWS KMS
	// encryption key.
	//
	// You can restore to a new DB cluster and encrypt the new DB cluster with an
	// AWS KMS key that is different from the AWS KMS key used to encrypt the source
	// DB cluster. The new DB cluster is encrypted with the AWS KMS key identified
	// by the KmsKeyId parameter.
	//
	// If you do not specify a value for the KmsKeyId parameter, then the following
	// occurs:
	//
	//    * If the DB cluster is encrypted, then the restored DB cluster is encrypted
	//    using the AWS KMS key that was used to encrypt the source DB cluster.
	//
	//    * If the DB cluster is not encrypted, then the restored DB cluster is
	//    not encrypted.
	//
	// If DBClusterIdentifier refers to a DB cluster that is not encrypted, then
	// the restore request is rejected.
	KmsKeyId *string `type:"string"`

	// The port number on which the new DB cluster accepts connections.
	//
	// Constraints: Must be a value from 1150 to 65535.
	//
	// Default: The default port for the engine.
	Port *int64 `type:"integer"`

	// The date and time to restore the DB cluster to.
	//
	// Valid values: A time in Universal Coordinated Time (UTC) format.
	//
	// Constraints:
	//
	//    * Must be before the latest restorable time for the DB instance.
	//
	//    * Must be specified if the UseLatestRestorableTime parameter is not provided.
	//
	//    * Cannot be specified if the UseLatestRestorableTime parameter is true.
	//
	//    * Cannot be specified if the RestoreType parameter is copy-on-write.
	//
	// Example: 2015-03-07T23:45:00Z
	RestoreToTime *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The identifier of the source DB cluster from which to restore.
	//
	// Constraints:
	//
	//    * Must match the identifier of an existing DBCluster.
	//
	// SourceDBClusterIdentifier is a required field
	SourceDBClusterIdentifier *string `type:"string" required:"true"`

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

	// A value that is set to true to restore the DB cluster to the latest restorable
	// backup time, and false otherwise.
	//
	// Default: false
	//
	// Constraints: Cannot be specified if the RestoreToTime parameter is provided.
	UseLatestRestorableTime *bool `type:"boolean"`

	// A list of VPC security groups that the new DB cluster belongs to.
	VpcSecurityGroupIds []string `locationNameList:"VpcSecurityGroupId" type:"list"`
	// contains filtered or unexported fields
}

Represents the input to RestoreDBClusterToPointInTime. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterToPointInTimeMessage

func (RestoreDBClusterToPointInTimeInput) String 

func (s RestoreDBClusterToPointInTimeInput) String() string

String returns the string representation

func (*RestoreDBClusterToPointInTimeInput) Validate 

func (s *RestoreDBClusterToPointInTimeInput) Validate() error

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

type RestoreDBClusterToPointInTimeOutput 

type RestoreDBClusterToPointInTimeOutput struct {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/RestoreDBClusterToPointInTimeResult

func (RestoreDBClusterToPointInTimeOutput) String 

func (s RestoreDBClusterToPointInTimeOutput) String() string

String returns the string representation

type RestoreDBClusterToPointInTimeRequest 

type RestoreDBClusterToPointInTimeRequest struct {
	*aws.Request
	Input *RestoreDBClusterToPointInTimeInput
	Copy  func(*RestoreDBClusterToPointInTimeInput) RestoreDBClusterToPointInTimeRequest
}

RestoreDBClusterToPointInTimeRequest is the request type for the RestoreDBClusterToPointInTime API operation.

func (RestoreDBClusterToPointInTimeRequest) Send 

func (r RestoreDBClusterToPointInTimeRequest) Send(ctx context.Context) (*RestoreDBClusterToPointInTimeResponse, error)

Send marshals and sends the RestoreDBClusterToPointInTime API request.

type RestoreDBClusterToPointInTimeResponse added in v0.9.0 

type RestoreDBClusterToPointInTimeResponse struct {
	*RestoreDBClusterToPointInTimeOutput
	// contains filtered or unexported fields
}

RestoreDBClusterToPointInTimeResponse is the response type for the RestoreDBClusterToPointInTime API operation.

func (*RestoreDBClusterToPointInTimeResponse) SDKResponseMetdata added in v0.9.0 

func (r *RestoreDBClusterToPointInTimeResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RestoreDBClusterToPointInTime request.

type SourceType 

type SourceType string
const (
	SourceTypeDbInstance        SourceType = "db-instance"
	SourceTypeDbParameterGroup  SourceType = "db-parameter-group"
	SourceTypeDbSecurityGroup   SourceType = "db-security-group"
	SourceTypeDbSnapshot        SourceType = "db-snapshot"
	SourceTypeDbCluster         SourceType = "db-cluster"
	SourceTypeDbClusterSnapshot SourceType = "db-cluster-snapshot"
)

Enum values for SourceType

func (SourceType) MarshalValue 

func (enum SourceType) MarshalValue() (string, error)

func (SourceType) MarshalValueBuf 

func (enum SourceType) MarshalValueBuf(b []byte) ([]byte, error)

type Subnet 

type Subnet struct {

	// Specifies the Availability Zone for the subnet.
	SubnetAvailabilityZone *AvailabilityZone `type:"structure"`

	// Specifies the identifier of the subnet.
	SubnetIdentifier *string `type:"string"`

	// Specifies the status of the subnet.
	SubnetStatus *string `type:"string"`
	// contains filtered or unexported fields
}

Detailed information about a subnet. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/Subnet

func (Subnet) String 

func (s Subnet) String() string

String returns the string representation

type Tag 

type Tag struct {

	// The required name of the tag. The string value can be from 1 to 128 Unicode
	// characters in length and can't be prefixed with "aws:" or "rds:". The string
	// can contain only the set of Unicode letters, digits, white space, '_', '.',
	// '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
	Key *string `type:"string"`

	// The optional value of the tag. The string value can be from 1 to 256 Unicode
	// characters in length and can't be prefixed with "aws:" or "rds:". The string
	// can contain only the set of Unicode letters, digits, white space, '_', '.',
	// '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/Tag

func (Tag) String 

func (s Tag) String() string

String returns the string representation

type UpgradeTarget 

type UpgradeTarget struct {

	// A value that indicates whether the target version is applied to any source
	// DB instances that have AutoMinorVersionUpgrade set to true.
	AutoUpgrade *bool `type:"boolean"`

	// The version of the database engine that a DB instance can be upgraded to.
	Description *string `type:"string"`

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

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

	// A value that indicates whether a database engine is upgraded to a major version.
	IsMajorVersionUpgrade *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The version of the database engine that a DB instance can be upgraded to. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/UpgradeTarget

func (UpgradeTarget) String 

func (s UpgradeTarget) String() string

String returns the string representation

type VpcSecurityGroupMembership 

type VpcSecurityGroupMembership struct {

	// The status of the VPC security group.
	Status *string `type:"string"`

	// The name of the VPC security group.
	VpcSecurityGroupId *string `type:"string"`
	// contains filtered or unexported fields
}

Used as a response element for queries on virtual private cloud (VPC) security group membership. Please also see https://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/VpcSecurityGroupMembership

func (VpcSecurityGroupMembership) String 

func (s VpcSecurityGroupMembership) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package docdbiface provides an interface to enable mocking the Amazon DocumentDB with MongoDB compatibility service client for testing your code.
 Package docdbiface provides an interface to enable mocking the Amazon DocumentDB with MongoDB compatibility service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.