1. Packages
  2. AWS Native
  3. API Docs
  4. redshift
  5. ClusterParameterGroup

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.redshift.ClusterParameterGroup

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    Resource Type definition for AWS::Redshift::ClusterParameterGroup

    Create ClusterParameterGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ClusterParameterGroup(name: string, args: ClusterParameterGroupArgs, opts?: CustomResourceOptions);
    @overload
    def ClusterParameterGroup(resource_name: str,
                              args: ClusterParameterGroupArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def ClusterParameterGroup(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              description: Optional[str] = None,
                              parameter_group_family: Optional[str] = None,
                              parameter_group_name: Optional[str] = None,
                              parameters: Optional[Sequence[ClusterParameterGroupParameterArgs]] = None,
                              tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewClusterParameterGroup(ctx *Context, name string, args ClusterParameterGroupArgs, opts ...ResourceOption) (*ClusterParameterGroup, error)
    public ClusterParameterGroup(string name, ClusterParameterGroupArgs args, CustomResourceOptions? opts = null)
    public ClusterParameterGroup(String name, ClusterParameterGroupArgs args)
    public ClusterParameterGroup(String name, ClusterParameterGroupArgs args, CustomResourceOptions options)
    
    type: aws-native:redshift:ClusterParameterGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ClusterParameterGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClusterParameterGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClusterParameterGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterParameterGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterParameterGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const clusterParameterGroupResource = new aws_native.redshift.ClusterParameterGroup("clusterParameterGroupResource", {
        description: "string",
        parameterGroupFamily: "string",
        parameterGroupName: "string",
        parameters: [{
            parameterName: "string",
            parameterValue: "string",
        }],
        tags: [{
            key: "string",
            value: "string",
        }],
    });
    
    Coming soon!
    

    ClusterParameterGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ClusterParameterGroup resource accepts the following input properties:

    Description string
    A description of the parameter group.
    ParameterGroupFamily string
    The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
    ParameterGroupName string
    The name of the cluster parameter group.
    Parameters List<Pulumi.AwsNative.Redshift.Inputs.ClusterParameterGroupParameter>
    An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    Description string
    A description of the parameter group.
    ParameterGroupFamily string
    The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
    ParameterGroupName string
    The name of the cluster parameter group.
    Parameters []ClusterParameterGroupParameterArgs
    An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    description String
    A description of the parameter group.
    parameterGroupFamily String
    The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
    parameterGroupName String
    The name of the cluster parameter group.
    parameters List<ClusterParameterGroupParameter>
    An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    description string
    A description of the parameter group.
    parameterGroupFamily string
    The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
    parameterGroupName string
    The name of the cluster parameter group.
    parameters ClusterParameterGroupParameter[]
    An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    description str
    A description of the parameter group.
    parameter_group_family str
    The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
    parameter_group_name str
    The name of the cluster parameter group.
    parameters Sequence[ClusterParameterGroupParameterArgs]
    An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    description String
    A description of the parameter group.
    parameterGroupFamily String
    The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.
    parameterGroupName String
    The name of the cluster parameter group.
    parameters List<Property Map>
    An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ClusterParameterGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ClusterParameterGroupParameter, ClusterParameterGroupParameterArgs

    ParameterName string
    The name of the parameter.
    ParameterValue string
    The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.
    ParameterName string
    The name of the parameter.
    ParameterValue string
    The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.
    parameterName String
    The name of the parameter.
    parameterValue String
    The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.
    parameterName string
    The name of the parameter.
    parameterValue string
    The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.
    parameter_name str
    The name of the parameter.
    parameter_value str
    The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.
    parameterName String
    The name of the parameter.
    parameterValue String
    The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi