1. Packages
  2. AWS
  3. API Docs
  4. rds
  5. getClusterParameterGroup
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

aws.rds.getClusterParameterGroup

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi

    Information about an RDS cluster parameter group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const test = aws.rds.getClusterParameterGroup({
        name: "default.postgres15",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    test = aws.rds.get_cluster_parameter_group(name="default.postgres15")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := rds.LookupClusterParameterGroup(ctx, &rds.LookupClusterParameterGroupArgs{
    			Name: "default.postgres15",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Aws.Rds.GetClusterParameterGroup.Invoke(new()
        {
            Name = "default.postgres15",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.rds.RdsFunctions;
    import com.pulumi.aws.rds.inputs.GetClusterParameterGroupArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var test = RdsFunctions.getClusterParameterGroup(GetClusterParameterGroupArgs.builder()
                .name("default.postgres15")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          Function: aws:rds:getClusterParameterGroup
          Arguments:
            name: default.postgres15
    

    Using getClusterParameterGroup

    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 getClusterParameterGroup(args: GetClusterParameterGroupArgs, opts?: InvokeOptions): Promise<GetClusterParameterGroupResult>
    function getClusterParameterGroupOutput(args: GetClusterParameterGroupOutputArgs, opts?: InvokeOptions): Output<GetClusterParameterGroupResult>
    def get_cluster_parameter_group(name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetClusterParameterGroupResult
    def get_cluster_parameter_group_output(name: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetClusterParameterGroupResult]
    func LookupClusterParameterGroup(ctx *Context, args *LookupClusterParameterGroupArgs, opts ...InvokeOption) (*LookupClusterParameterGroupResult, error)
    func LookupClusterParameterGroupOutput(ctx *Context, args *LookupClusterParameterGroupOutputArgs, opts ...InvokeOption) LookupClusterParameterGroupResultOutput

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

    public static class GetClusterParameterGroup 
    {
        public static Task<GetClusterParameterGroupResult> InvokeAsync(GetClusterParameterGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetClusterParameterGroupResult> Invoke(GetClusterParameterGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetClusterParameterGroupResult> getClusterParameterGroup(GetClusterParameterGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:rds/getClusterParameterGroup:getClusterParameterGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    DB cluster parameter group name.
    Name string
    DB cluster parameter group name.
    name String
    DB cluster parameter group name.
    name string
    DB cluster parameter group name.
    name str
    DB cluster parameter group name.
    name String
    DB cluster parameter group name.

    getClusterParameterGroup Result

    The following output properties are available:

    Arn string
    ARN of the cluster parameter group.
    Description string
    Description of the cluster parameter group.
    Family string
    Family of the cluster parameter group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Arn string
    ARN of the cluster parameter group.
    Description string
    Description of the cluster parameter group.
    Family string
    Family of the cluster parameter group.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    arn String
    ARN of the cluster parameter group.
    description String
    Description of the cluster parameter group.
    family String
    Family of the cluster parameter group.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    arn string
    ARN of the cluster parameter group.
    description string
    Description of the cluster parameter group.
    family string
    Family of the cluster parameter group.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    arn str
    ARN of the cluster parameter group.
    description str
    Description of the cluster parameter group.
    family str
    Family of the cluster parameter group.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    arn String
    ARN of the cluster parameter group.
    description String
    Description of the cluster parameter group.
    family String
    Family of the cluster parameter group.
    id String
    The provider-assigned unique ID for this managed resource.
    name String

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi