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

Class: Aws::DocDB::Types::CopyDBClusterParameterGroupMessage

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

Overview

Note:

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

{
  source_db_cluster_parameter_group_identifier: "String", # required
  target_db_cluster_parameter_group_identifier: "String", # required
  target_db_cluster_parameter_group_description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
}

Represents the input to CopyDBClusterParameterGroup.

Instance Attribute Summary collapse

Instance Attribute Details

#source_db_cluster_parameter_group_identifierString

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.

Returns:

  • (String)


206
207
208
209
210
211
212
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 206

class CopyDBClusterParameterGroupMessage < Struct.new(
  :source_db_cluster_parameter_group_identifier,
  :target_db_cluster_parameter_group_identifier,
  :target_db_cluster_parameter_group_description,
  :tags)
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tags that are to be assigned to the parameter group.

Returns:



206
207
208
209
210
211
212
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 206

class CopyDBClusterParameterGroupMessage < Struct.new(
  :source_db_cluster_parameter_group_identifier,
  :target_db_cluster_parameter_group_identifier,
  :target_db_cluster_parameter_group_description,
  :tags)
  include Aws::Structure
end

#target_db_cluster_parameter_group_descriptionString

A description for the copied DB cluster parameter group.

Returns:

  • (String)


206
207
208
209
210
211
212
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 206

class CopyDBClusterParameterGroupMessage < Struct.new(
  :source_db_cluster_parameter_group_identifier,
  :target_db_cluster_parameter_group_identifier,
  :target_db_cluster_parameter_group_description,
  :tags)
  include Aws::Structure
end

#target_db_cluster_parameter_group_identifierString

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

Returns:

  • (String)


206
207
208
209
210
211
212
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 206

class CopyDBClusterParameterGroupMessage < Struct.new(
  :source_db_cluster_parameter_group_identifier,
  :target_db_cluster_parameter_group_identifier,
  :target_db_cluster_parameter_group_description,
  :tags)
  include Aws::Structure
end