Class: Aws::RDS::Types::CopyDBClusterParameterGroupMessage

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/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",
    },
  ],
}

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. For information about creating an ARN, see

Constructing an ARN for Amazon RDS][1

in the *Amazon Aurora User

Guide*.

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing

Returns:

  • (String)


633
634
635
636
637
638
639
# File 'lib/aws-sdk-rds/types.rb', line 633

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>

A list of tags. For more information, see [Tagging Amazon RDS Resources] in the *Amazon RDS User Guide.*

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html

Returns:



633
634
635
636
637
638
639
# File 'lib/aws-sdk-rds/types.rb', line 633

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)


633
634
635
636
637
638
639
# File 'lib/aws-sdk-rds/types.rb', line 633

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:

  • Can’t be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can’t end with a hyphen or contain two consecutive hyphens

Example: ‘my-cluster-param-group1`

Returns:

  • (String)


633
634
635
636
637
638
639
# File 'lib/aws-sdk-rds/types.rb', line 633

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