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

Class: Aws::Redshift::Types::CreateClusterParameterGroupMessage

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 CreateClusterParameterGroupMessage data as a hash:

{
  parameter_group_name: "String", # required
  parameter_group_family: "String", # required
  description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the parameter group.

Returns:

  • (String)


1416
1417
1418
1419
1420
1421
1422
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 1416

class CreateClusterParameterGroupMessage < Struct.new(
  :parameter_group_name,
  :parameter_group_family,
  :description,
  :tags)
  include Aws::Structure
end

#parameter_group_familyString

The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.

To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0".

Returns:

  • (String)


1416
1417
1418
1419
1420
1421
1422
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 1416

class CreateClusterParameterGroupMessage < Struct.new(
  :parameter_group_name,
  :parameter_group_family,
  :description,
  :tags)
  include Aws::Structure
end

#parameter_group_nameString

The name of the cluster parameter group.

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

  • Must be unique withing your AWS account.

This value is stored as a lower-case string.

Returns:

  • (String)


1416
1417
1418
1419
1420
1421
1422
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 1416

class CreateClusterParameterGroupMessage < Struct.new(
  :parameter_group_name,
  :parameter_group_family,
  :description,
  :tags)
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of tag instances.

Returns:



1416
1417
1418
1419
1420
1421
1422
# File 'gems/aws-sdk-redshift/lib/aws-sdk-redshift/types.rb', line 1416

class CreateClusterParameterGroupMessage < Struct.new(
  :parameter_group_name,
  :parameter_group_family,
  :description,
  :tags)
  include Aws::Structure
end