You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Redshift::Types::CreateClusterSnapshotMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb

Overview

Note:

When making an API call, you may pass CreateClusterSnapshotMessage data as a hash:

{
  snapshot_identifier: "String", # required
  cluster_identifier: "String", # required
  manual_snapshot_retention_period: 1,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cluster_identifier ⇒ String

The cluster identifier for which you want a snapshot.

Returns:

  • (String) 


1959
1960
1961
1962
1963
1964
1965
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 1959

class CreateClusterSnapshotMessage < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :manual_snapshot_retention_period,
  :tags)
  include Aws::Structure
end

#manual_snapshot_retention_period ⇒ Integer

The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

The value must be either -1 or an integer between 1 and 3,653.

The default value is -1.

Returns:

  • (Integer) 


1959
1960
1961
1962
1963
1964
1965
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 1959

class CreateClusterSnapshotMessage < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :manual_snapshot_retention_period,
  :tags)
  include Aws::Structure
end

#snapshot_identifier ⇒ String

A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.

Constraints:

  • Cannot be null, empty, or blank

  • Must contain from 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Returns:

  • (String) 


1959
1960
1961
1962
1963
1964
1965
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 1959

class CreateClusterSnapshotMessage < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :manual_snapshot_retention_period,
  :tags)
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of tag instances.

Returns:



1959
1960
1961
1962
1963
1964
1965
 
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 1959

class CreateClusterSnapshotMessage < Struct.new(
  :snapshot_identifier,
  :cluster_identifier,
  :manual_snapshot_retention_period,
  :tags)
  include Aws::Structure
end