GetCluster
Provides information about an RDS cluster.
Example Usage
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var clusterName = Output.Create(Aws.Rds.GetCluster.InvokeAsync(new Aws.Rds.GetClusterArgs
{
ClusterIdentifier = "clusterName",
}));
}
}
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v2/go/aws/rds"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rds.LookupCluster(ctx, &rds.LookupClusterArgs{
ClusterIdentifier: "clusterName",
}, nil)
if err != nil {
return err
}
return nil
})
}import pulumi
import pulumi_aws as aws
cluster_name = aws.rds.get_cluster(cluster_identifier="clusterName")import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const clusterName = pulumi.output(aws.rds.getCluster({
clusterIdentifier: "clusterName",
}, { async: true }));Using GetCluster
function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>function get_cluster(cluster_identifier=None, tags=None, opts=None)func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)Note: This function is named
LookupClusterin the Go SDK.
public static class GetCluster {
public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
}The following arguments are supported:
- Cluster
Identifier string The cluster identifier of the RDS cluster.
- Dictionary<string, string>
- Cluster
Identifier string The cluster identifier of the RDS cluster.
- map[string]string
- cluster
Identifier string The cluster identifier of the RDS cluster.
- {[key: string]: string}
- cluster_
identifier str The cluster identifier of the RDS cluster.
- Dict[str, str]
GetCluster Result
The following output properties are available:
- Arn string
- Availability
Zones List<string> - Backtrack
Window int - Backup
Retention intPeriod - Cluster
Identifier string - Cluster
Members List<string> - Cluster
Resource stringId - Database
Name string - Db
Cluster stringParameter Group Name - Db
Subnet stringGroup Name - Enabled
Cloudwatch List<string>Logs Exports - Endpoint string
- Engine string
- Engine
Version string - Final
Snapshot stringIdentifier - Hosted
Zone stringId - Iam
Database boolAuthentication Enabled - Iam
Roles List<string> - Id string
The provider-assigned unique ID for this managed resource.
- Kms
Key stringId - Master
Username string - Port int
- Preferred
Backup stringWindow - Preferred
Maintenance stringWindow - Reader
Endpoint string - Replication
Source stringIdentifier - Storage
Encrypted bool - Dictionary<string, string>
- Vpc
Security List<string>Group Ids
- Arn string
- Availability
Zones []string - Backtrack
Window int - Backup
Retention intPeriod - Cluster
Identifier string - Cluster
Members []string - Cluster
Resource stringId - Database
Name string - Db
Cluster stringParameter Group Name - Db
Subnet stringGroup Name - Enabled
Cloudwatch []stringLogs Exports - Endpoint string
- Engine string
- Engine
Version string - Final
Snapshot stringIdentifier - Hosted
Zone stringId - Iam
Database boolAuthentication Enabled - Iam
Roles []string - Id string
The provider-assigned unique ID for this managed resource.
- Kms
Key stringId - Master
Username string - Port int
- Preferred
Backup stringWindow - Preferred
Maintenance stringWindow - Reader
Endpoint string - Replication
Source stringIdentifier - Storage
Encrypted bool - map[string]string
- Vpc
Security []stringGroup Ids
- arn string
- availability
Zones string[] - backtrack
Window number - backup
Retention numberPeriod - cluster
Identifier string - cluster
Members string[] - cluster
Resource stringId - database
Name string - db
Cluster stringParameter Group Name - db
Subnet stringGroup Name - enabled
Cloudwatch string[]Logs Exports - endpoint string
- engine string
- engine
Version string - final
Snapshot stringIdentifier - hosted
Zone stringId - iam
Database booleanAuthentication Enabled - iam
Roles string[] - id string
The provider-assigned unique ID for this managed resource.
- kms
Key stringId - master
Username string - port number
- preferred
Backup stringWindow - preferred
Maintenance stringWindow - reader
Endpoint string - replication
Source stringIdentifier - storage
Encrypted boolean - {[key: string]: string}
- vpc
Security string[]Group Ids
- arn str
- availability_
zones List[str] - backtrack_
window float - backup_
retention_ floatperiod - cluster_
identifier str - cluster_
members List[str] - cluster_
resource_ strid - database_
name str - db_
cluster_ strparameter_ group_ name - db_
subnet_ strgroup_ name - enabled_
cloudwatch_ List[str]logs_ exports - endpoint str
- engine str
- engine_
version str - final_
snapshot_ stridentifier - hosted_
zone_ strid - iam_
database_ boolauthentication_ enabled - iam_
roles List[str] - id str
The provider-assigned unique ID for this managed resource.
- kms_
key_ strid - master_
username str - port float
- preferred_
backup_ strwindow - preferred_
maintenance_ strwindow - reader_
endpoint str - replication_
source_ stridentifier - storage_
encrypted bool - Dict[str, str]
- vpc_
security_ List[str]group_ ids
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.