AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DBClusterSnapshot

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

type DBClusterSnapshot struct { AllocatedStorage *int64 `type:"integer"` AvailabilityZones []*string `locationNameList:"AvailabilityZone" type:"list"` ClusterCreateTime *time.Time `type:"timestamp"` DBClusterIdentifier *string `type:"string"` DBClusterSnapshotArn *string `type:"string"` DBClusterSnapshotIdentifier *string `type:"string"` Engine *string `type:"string"` EngineVersion *string `type:"string"` IAMDatabaseAuthenticationEnabled *bool `type:"boolean"` KmsKeyId *string `type:"string"` LicenseModel *string `type:"string"` MasterUsername *string `type:"string"` PercentProgress *int64 `type:"integer"` Port *int64 `type:"integer"` SnapshotCreateTime *time.Time `type:"timestamp"` SnapshotType *string `type:"string"` SourceDBClusterSnapshotArn *string `type:"string"` Status *string `type:"string"` StorageEncrypted *bool `type:"boolean"` VpcId *string `type:"string"` }

Contains the details for an Amazon RDS DB cluster snapshot

This data type is used as a response element in the DescribeDBClusterSnapshots action.

AllocatedStorage

Type: *int64

Specifies the allocated storage size in gibibytes (GiB).

AvailabilityZones

Type: []*string

Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

ClusterCreateTime

Type: *time.Time

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

DBClusterIdentifier

Type: *string

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

DBClusterSnapshotArn

Type: *string

The Amazon Resource Name (ARN) for the DB cluster snapshot.

DBClusterSnapshotIdentifier

Type: *string

Specifies the identifier for the DB cluster snapshot.

Engine

Type: *string

Specifies the name of the database engine.

EngineVersion

Type: *string

Provides the version of the database engine for this DB cluster snapshot.

IAMDatabaseAuthenticationEnabled

Type: *bool

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

KmsKeyId

Type: *string

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

LicenseModel

Type: *string

Provides the license model information for this DB cluster snapshot.

MasterUsername

Type: *string

Provides the master username for the DB cluster snapshot.

PercentProgress

Type: *int64

Specifies the percentage of the estimated data that has been transferred.

Port

Type: *int64

Specifies the port that the DB cluster was listening on at the time of the snapshot.

SnapshotCreateTime

Type: *time.Time

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

SnapshotType

Type: *string

Provides the type of the DB cluster snapshot.

SourceDBClusterSnapshotArn

Type: *string

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

Status

Type: *string

Specifies the status of this DB cluster snapshot.

StorageEncrypted

Type: *bool

Specifies whether the DB cluster snapshot is encrypted.

VpcId

Type: *string

Provides the VPC ID associated with the DB cluster snapshot.

Method

GoString

func (s DBClusterSnapshot) GoString() string

GoString returns the string representation

SetAllocatedStorage

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

SetAllocatedStorage sets the AllocatedStorage field's value.

SetAvailabilityZones

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

SetAvailabilityZones sets the AvailabilityZones field's value.

SetClusterCreateTime

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

SetClusterCreateTime sets the ClusterCreateTime field's value.

SetDBClusterIdentifier

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

SetDBClusterIdentifier sets the DBClusterIdentifier field's value.

SetDBClusterSnapshotArn

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

SetDBClusterSnapshotArn sets the DBClusterSnapshotArn field's value.

SetDBClusterSnapshotIdentifier

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

SetDBClusterSnapshotIdentifier sets the DBClusterSnapshotIdentifier field's value.

SetEngine

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

SetEngine sets the Engine field's value.

SetEngineVersion

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

SetEngineVersion sets the EngineVersion field's value.

SetIAMDatabaseAuthenticationEnabled

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

SetIAMDatabaseAuthenticationEnabled sets the IAMDatabaseAuthenticationEnabled field's value.

SetKmsKeyId

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

SetKmsKeyId sets the KmsKeyId field's value.

SetLicenseModel

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

SetLicenseModel sets the LicenseModel field's value.

SetMasterUsername

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

SetMasterUsername sets the MasterUsername field's value.

SetPercentProgress

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

SetPercentProgress sets the PercentProgress field's value.

SetPort

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

SetPort sets the Port field's value.

SetSnapshotCreateTime

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

SetSnapshotCreateTime sets the SnapshotCreateTime field's value.

SetSnapshotType

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

SetSnapshotType sets the SnapshotType field's value.

SetSourceDBClusterSnapshotArn

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

SetSourceDBClusterSnapshotArn sets the SourceDBClusterSnapshotArn field's value.

SetStatus

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

SetStatus sets the Status field's value.

SetStorageEncrypted

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

SetStorageEncrypted sets the StorageEncrypted field's value.

SetVpcId

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

SetVpcId sets the VpcId field's value.

String

func (s DBClusterSnapshot) String() string

String returns the string representation

On this page: