types

package
v0.0.0-...-68f2935 Latest Latest
Warning

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

 Go to latest Published: May 24, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type Auth 

type Auth string
const (
	AuthPlainText Auth = "PLAIN_TEXT"
	AuthSecretArn Auth = "SECRET_ARN"
)

Enum values for Auth

func (Auth) Values 

func (Auth) Values() []Auth

Values returns all known values for Auth. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Cluster 

type Cluster struct {

	// The name of the elastic cluster administrator.
	//
	// This member is required.
	AdminUserName *string

	// The authentication type for the elastic cluster.
	//
	// This member is required.
	AuthType Auth

	// The ARN identifier of the elastic cluster.
	//
	// This member is required.
	ClusterArn *string

	// The URL used to connect to the elastic cluster.
	//
	// This member is required.
	ClusterEndpoint *string

	// The name of the elastic cluster.
	//
	// This member is required.
	ClusterName *string

	// The time when the elastic cluster was created in Universal Coordinated Time
	// (UTC).
	//
	// This member is required.
	CreateTime *string

	// The KMS key identifier to use to encrypt the elastic cluster.
	//
	// This member is required.
	KmsKeyId *string

	// The weekly time range during which system maintenance can occur, in Universal
	// Coordinated Time (UTC).
	//
	// Format: ddd:hh24:mi-ddd:hh24:mi
	//
	// This member is required.
	PreferredMaintenanceWindow *string

	// The number of vCPUs assigned to each elastic cluster shard. Maximum is 64.
	// Allowed values are 2, 4, 8, 16, 32, 64.
	//
	// This member is required.
	ShardCapacity *int32

	// The number of shards assigned to the elastic cluster. Maximum is 32.
	//
	// This member is required.
	ShardCount *int32

	// The status of the elastic cluster.
	//
	// This member is required.
	Status Status

	// The Amazon EC2 subnet IDs for the elastic cluster.
	//
	// This member is required.
	SubnetIds []string

	// A list of EC2 VPC security groups associated with thie elastic cluster.
	//
	// This member is required.
	VpcSecurityGroupIds []string

	// The number of days for which automatic snapshots are retained.
	BackupRetentionPeriod *int32

	// The daily time range during which automated backups are created if automated
	// backups are enabled, as determined by backupRetentionPeriod .
	PreferredBackupWindow *string

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

	// The total number of shards in the cluster.
	Shards []Shard
	// contains filtered or unexported fields
}

Returns information about a specific elastic cluster.

type ClusterInList 

type ClusterInList struct {

	// The ARN identifier of the elastic cluster.
	//
	// This member is required.
	ClusterArn *string

	// The name of the elastic cluster.
	//
	// This member is required.
	ClusterName *string

	// The status of the elastic cluster.
	//
	// This member is required.
	Status Status
	// contains filtered or unexported fields
}

A list of Amazon DocumentDB elastic clusters.

type ClusterSnapshot 

type ClusterSnapshot struct {

	// The name of the elastic cluster administrator.
	//
	// This member is required.
	AdminUserName *string

	// The ARN identifier of the elastic cluster.
	//
	// This member is required.
	ClusterArn *string

	// The time when the elastic cluster was created in Universal Coordinated Time
	// (UTC).
	//
	// This member is required.
	ClusterCreationTime *string

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

	// The ARN identifier of the elastic cluster snapshot.
	//
	// This member is required.
	SnapshotArn *string

	// The time when the elastic cluster snapshot was created in Universal Coordinated
	// Time (UTC).
	//
	// This member is required.
	SnapshotCreationTime *string

	// The name of the elastic cluster snapshot.
	//
	// This member is required.
	SnapshotName *string

	// The status of the elastic cluster snapshot.
	//
	// This member is required.
	Status Status

	// The Amazon EC2 subnet IDs for the elastic cluster.
	//
	// This member is required.
	SubnetIds []string

	// A list of EC2 VPC security groups to associate with the elastic cluster.
	//
	// This member is required.
	VpcSecurityGroupIds []string

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

Returns information about a specific elastic cluster snapshot.

type ClusterSnapshotInList 

type ClusterSnapshotInList struct {

	// The ARN identifier of the elastic cluster.
	//
	// This member is required.
	ClusterArn *string

	// The ARN identifier of the elastic cluster snapshot.
	//
	// This member is required.
	SnapshotArn *string

	// The time when the elastic cluster snapshot was created in Universal Coordinated
	// Time (UTC).
	//
	// This member is required.
	SnapshotCreationTime *string

	// The name of the elastic cluster snapshot.
	//
	// This member is required.
	SnapshotName *string

	// The status of the elastic cluster snapshot.
	//
	// This member is required.
	Status Status
	// contains filtered or unexported fields
}

A list of elastic cluster snapshots.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

There was an access conflict.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

There was an internal server error.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The specified resource could not be located.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The service quota for the action was exceeded.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type Shard 

type Shard struct {

	// The time when the shard was created in Universal Coordinated Time (UTC).
	//
	// This member is required.
	CreateTime *string

	// The ID of the shard.
	//
	// This member is required.
	ShardId *string

	// The current status of the shard.
	//
	// This member is required.
	Status Status
	// contains filtered or unexported fields
}

The name of the shard.

type SnapshotType 

type SnapshotType string
const (
	SnapshotTypeManual    SnapshotType = "MANUAL"
	SnapshotTypeAutomated SnapshotType = "AUTOMATED"
)

Enum values for SnapshotType

func (SnapshotType) Values 

func (SnapshotType) Values() []SnapshotType

Values returns all known values for SnapshotType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Status 

type Status string
const (
	StatusCreating                    Status = "CREATING"
	StatusActive                      Status = "ACTIVE"
	StatusDeleting                    Status = "DELETING"
	StatusUpdating                    Status = "UPDATING"
	StatusVpcEndpointLimitExceeded    Status = "VPC_ENDPOINT_LIMIT_EXCEEDED"
	StatusIpAddressLimitExceeded      Status = "IP_ADDRESS_LIMIT_EXCEEDED"
	StatusInvalidSecurityGroupId      Status = "INVALID_SECURITY_GROUP_ID"
	StatusInvalidSubnetId             Status = "INVALID_SUBNET_ID"
	StatusInaccessibleEncryptionCreds Status = "INACCESSIBLE_ENCRYPTION_CREDS"
	StatusInaccessibleSecretArn       Status = "INACCESSIBLE_SECRET_ARN"
	StatusInaccessibleVpcEndpoint     Status = "INACCESSIBLE_VPC_ENDPOINT"
	StatusIncompatibleNetwork         Status = "INCOMPATIBLE_NETWORK"
	StatusMerging                     Status = "MERGING"
	StatusModifying                   Status = "MODIFYING"
	StatusSplitting                   Status = "SPLITTING"
	StatusCopying                     Status = "COPYING"
	StatusStarting                    Status = "STARTING"
	StatusStopping                    Status = "STOPPING"
	StatusStopped                     Status = "STOPPED"
)

Enum values for Status

func (Status) Values 

func (Status) Values() []Status

Values returns all known values for Status. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds *int32
	// contains filtered or unexported fields
}

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

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason    ValidationExceptionReason
	FieldList []ValidationExceptionField
	// contains filtered or unexported fields
}

A structure defining a validation exception.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionField 

type ValidationExceptionField struct {

	// An error message describing the validation exception in this field.
	//
	// This member is required.
	Message *string

	// The name of the field where the validation exception occurred.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

A specific field in which a given validation exception occurred.

type ValidationExceptionReason 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "unknownOperation"
	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "cannotParse"
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "fieldValidationFailed"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "other"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values 

func (ValidationExceptionReason) Values() []ValidationExceptionReason

Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

Source Files

View all Source files

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.