Class CfnClusterParameterGroup

A CloudFormation AWS::Redshift::ClusterParameterGroup.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnClusterParameterGroup

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.Redshift

Assembly: Amazon.CDK.AWS.Redshift.dll

Syntax (csharp)

public class CfnClusterParameterGroup : CfnResource, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnClusterParameterGroup
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable

Remarks

Describes a parameter group.

CloudformationResource: AWS::Redshift::ClusterParameterGroup

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Redshift;

var cfnClusterParameterGroup = new CfnClusterParameterGroup(this, "MyCfnClusterParameterGroup", new CfnClusterParameterGroupProps {
    Description = "description",
    ParameterGroupFamily = "parameterGroupFamily",

    // the properties below are optional
    ParameterGroupName = "parameterGroupName",
    Parameters = new [] { new ParameterProperty {
        ParameterName = "parameterName",
        ParameterValue = "parameterValue"
    } },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

CfnClusterParameterGroup(Construct, String, ICfnClusterParameterGroupProps)	Create a new `AWS::Redshift::ClusterParameterGroup`.
CfnClusterParameterGroup(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnClusterParameterGroup(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Properties

CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
Description	The description of the parameter group.
ParameterGroupFamily	The name of the cluster parameter group family that this cluster parameter group is compatible with.
ParameterGroupName	The name of the cluster parameter group.
Parameters	An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
Tags	The list of tags for the cluster parameter group.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnClusterParameterGroup(Construct, String, ICfnClusterParameterGroupProps)

Create a new AWS::Redshift::ClusterParameterGroup.

public CfnClusterParameterGroup(Construct scope, string id, ICfnClusterParameterGroupProps props)

Parameters

scope Construct

scope in which this resource is defined.

id System.String

scoped id of the resource.

props ICfnClusterParameterGroupProps

resource properties.

CfnClusterParameterGroup(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnClusterParameterGroup(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnClusterParameterGroup(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnClusterParameterGroup(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

Description

The description of the parameter group.

public virtual string Description { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-description

ParameterGroupFamily

The name of the cluster parameter group family that this cluster parameter group is compatible with.

public virtual string ParameterGroupFamily { get; set; }

Property Value

System.String

Remarks

You can create a custom parameter group and then associate your cluster with it. For more information, see Amazon Redshift parameter groups .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-parametergroupfamily

ParameterGroupName

The name of the cluster parameter group.

public virtual string ParameterGroupName { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-parametergroupname

Parameters

An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.

public virtual object Parameters { get; set; }

Property Value

System.Object

Remarks

For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.

For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-clusterparametergroup.html#cfn-redshift-clusterparametergroup-parameters

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable