1. Packages
  2. AWS Native
  3. API Docs
  4. rds
  5. getDbClusterParameterGroup

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

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi

aws-native.rds.getDbClusterParameterGroup

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi

    The AWS::RDS::DBClusterParameterGroup resource creates a new Amazon RDS DB cluster parameter group. For information about configuring parameters for Amazon Aurora DB clusters, see Working with parameter groups in the Amazon Aurora User Guide. If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting. If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.

    Using getDbClusterParameterGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDbClusterParameterGroup(args: GetDbClusterParameterGroupArgs, opts?: InvokeOptions): Promise<GetDbClusterParameterGroupResult>
    function getDbClusterParameterGroupOutput(args: GetDbClusterParameterGroupOutputArgs, opts?: InvokeOptions): Output<GetDbClusterParameterGroupResult>
    def get_db_cluster_parameter_group(db_cluster_parameter_group_name: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetDbClusterParameterGroupResult
    def get_db_cluster_parameter_group_output(db_cluster_parameter_group_name: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetDbClusterParameterGroupResult]
    func LookupDbClusterParameterGroup(ctx *Context, args *LookupDbClusterParameterGroupArgs, opts ...InvokeOption) (*LookupDbClusterParameterGroupResult, error)
    func LookupDbClusterParameterGroupOutput(ctx *Context, args *LookupDbClusterParameterGroupOutputArgs, opts ...InvokeOption) LookupDbClusterParameterGroupResultOutput

    > Note: This function is named LookupDbClusterParameterGroup in the Go SDK.

    public static class GetDbClusterParameterGroup 
    {
        public static Task<GetDbClusterParameterGroupResult> InvokeAsync(GetDbClusterParameterGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetDbClusterParameterGroupResult> Invoke(GetDbClusterParameterGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDbClusterParameterGroupResult> getDbClusterParameterGroup(GetDbClusterParameterGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:rds:getDbClusterParameterGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DbClusterParameterGroupName string

    The name of the DB cluster parameter group. Constraints:

    • Must not match the name of an existing DB cluster parameter group.

    If you don't specify a value for DBClusterParameterGroupName property, a name is automatically created for the DB cluster parameter group. This value is stored as a lowercase string.

    DbClusterParameterGroupName string

    The name of the DB cluster parameter group. Constraints:

    • Must not match the name of an existing DB cluster parameter group.

    If you don't specify a value for DBClusterParameterGroupName property, a name is automatically created for the DB cluster parameter group. This value is stored as a lowercase string.

    dbClusterParameterGroupName String

    The name of the DB cluster parameter group. Constraints:

    • Must not match the name of an existing DB cluster parameter group.

    If you don't specify a value for DBClusterParameterGroupName property, a name is automatically created for the DB cluster parameter group. This value is stored as a lowercase string.

    dbClusterParameterGroupName string

    The name of the DB cluster parameter group. Constraints:

    • Must not match the name of an existing DB cluster parameter group.

    If you don't specify a value for DBClusterParameterGroupName property, a name is automatically created for the DB cluster parameter group. This value is stored as a lowercase string.

    db_cluster_parameter_group_name str

    The name of the DB cluster parameter group. Constraints:

    • Must not match the name of an existing DB cluster parameter group.

    If you don't specify a value for DBClusterParameterGroupName property, a name is automatically created for the DB cluster parameter group. This value is stored as a lowercase string.

    dbClusterParameterGroupName String

    The name of the DB cluster parameter group. Constraints:

    • Must not match the name of an existing DB cluster parameter group.

    If you don't specify a value for DBClusterParameterGroupName property, a name is automatically created for the DB cluster parameter group. This value is stored as a lowercase string.

    getDbClusterParameterGroup Result

    The following output properties are available:

    Parameters object

    Provides a list of parameters for the DB cluster parameter group.

    Search the CloudFormation User Guide for AWS::RDS::DBClusterParameterGroup for more information about the expected schema for this property.

    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An optional array of key-value pairs to apply to this DB cluster parameter group.
    Parameters interface{}

    Provides a list of parameters for the DB cluster parameter group.

    Search the CloudFormation User Guide for AWS::RDS::DBClusterParameterGroup for more information about the expected schema for this property.

    Tags Tag
    An optional array of key-value pairs to apply to this DB cluster parameter group.
    parameters Object

    Provides a list of parameters for the DB cluster parameter group.

    Search the CloudFormation User Guide for AWS::RDS::DBClusterParameterGroup for more information about the expected schema for this property.

    tags List<Tag>
    An optional array of key-value pairs to apply to this DB cluster parameter group.
    parameters any

    Provides a list of parameters for the DB cluster parameter group.

    Search the CloudFormation User Guide for AWS::RDS::DBClusterParameterGroup for more information about the expected schema for this property.

    tags Tag[]
    An optional array of key-value pairs to apply to this DB cluster parameter group.
    parameters Any

    Provides a list of parameters for the DB cluster parameter group.

    Search the CloudFormation User Guide for AWS::RDS::DBClusterParameterGroup for more information about the expected schema for this property.

    tags Sequence[root_Tag]
    An optional array of key-value pairs to apply to this DB cluster parameter group.
    parameters Any

    Provides a list of parameters for the DB cluster parameter group.

    Search the CloudFormation User Guide for AWS::RDS::DBClusterParameterGroup for more information about the expected schema for this property.

    tags List<Property Map>
    An optional array of key-value pairs to apply to this DB cluster parameter group.

    Supporting Types

    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 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.112.0 published on Wednesday, Jul 24, 2024 by Pulumi