AWS v6.61.0 published on Tuesday, Nov 26, 2024 by Pulumi
aws.rds.getCluster
Explore with Pulumi AI
Provides information about an RDS cluster.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const clusterName = aws.rds.getCluster({
clusterIdentifier: "clusterName",
});
import pulumi
import pulumi_aws as aws
cluster_name = aws.rds.get_cluster(cluster_identifier="clusterName")
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.LookupCluster(ctx, &rds.LookupClusterArgs{
ClusterIdentifier: "clusterName",
}, 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 clusterName = Aws.Rds.GetCluster.Invoke(new()
{
ClusterIdentifier = "clusterName",
});
});
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.GetClusterArgs;
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 clusterName = RdsFunctions.getCluster(GetClusterArgs.builder()
.clusterIdentifier("clusterName")
.build());
}
}
variables:
clusterName:
fn::invoke:
Function: aws:rds:getCluster
Arguments:
clusterIdentifier: clusterName
Using getCluster
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 getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
def get_cluster(cluster_identifier: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_identifier: Optional[pulumi.Input[str]] = None,
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput
> Note: This function is named LookupCluster
in the Go SDK.
public static class GetCluster
{
public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:rds/getCluster:getCluster
arguments:
# arguments dictionary
The following arguments are supported:
- Cluster
Identifier string - Cluster identifier of the RDS cluster.
- Dictionary<string, string>
- A map of tags assigned to the resource.
- Cluster
Identifier string - Cluster identifier of the RDS cluster.
- map[string]string
- A map of tags assigned to the resource.
- cluster
Identifier String - Cluster identifier of the RDS cluster.
- Map<String,String>
- A map of tags assigned to the resource.
- cluster
Identifier string - Cluster identifier of the RDS cluster.
- {[key: string]: string}
- A map of tags assigned to the resource.
- cluster_
identifier str - Cluster identifier of the RDS cluster.
- Mapping[str, str]
- A map of tags assigned to the resource.
- cluster
Identifier String - Cluster identifier of the RDS cluster.
- Map<String>
- A map of tags assigned to the resource.
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 - Db
System stringId - Enabled
Cloudwatch List<string>Logs Exports - Endpoint string
- Engine string
- Engine
Mode 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
User List<GetSecrets Cluster Master User Secret> - Master
Username string - Network
Type string - Port int
- Preferred
Backup stringWindow - Preferred
Maintenance stringWindow - Reader
Endpoint string - Replication
Source stringIdentifier - Storage
Encrypted bool - Dictionary<string, string>
- A map of tags assigned to the resource.
- 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 - Db
System stringId - Enabled
Cloudwatch []stringLogs Exports - Endpoint string
- Engine string
- Engine
Mode 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
User []GetSecrets Cluster Master User Secret - Master
Username string - Network
Type string - Port int
- Preferred
Backup stringWindow - Preferred
Maintenance stringWindow - Reader
Endpoint string - Replication
Source stringIdentifier - Storage
Encrypted bool - map[string]string
- A map of tags assigned to the resource.
- Vpc
Security []stringGroup Ids
- arn String
- availability
Zones List<String> - backtrack
Window Integer - backup
Retention IntegerPeriod - cluster
Identifier String - cluster
Members List<String> - cluster
Resource StringId - database
Name String - db
Cluster StringParameter Group Name - db
Subnet StringGroup Name - db
System StringId - enabled
Cloudwatch List<String>Logs Exports - endpoint String
- engine String
- engine
Mode String - engine
Version String - final
Snapshot StringIdentifier - hosted
Zone StringId - iam
Database BooleanAuthentication Enabled - iam
Roles List<String> - id String
- The provider-assigned unique ID for this managed resource.
- kms
Key StringId - master
User List<GetSecrets Cluster Master User Secret> - master
Username String - network
Type String - port Integer
- preferred
Backup StringWindow - preferred
Maintenance StringWindow - reader
Endpoint String - replication
Source StringIdentifier - storage
Encrypted Boolean - Map<String,String>
- A map of tags assigned to the resource.
- vpc
Security List<String>Group 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 - db
System stringId - enabled
Cloudwatch string[]Logs Exports - endpoint string
- engine string
- engine
Mode 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
User GetSecrets Cluster Master User Secret[] - master
Username string - network
Type string - port number
- preferred
Backup stringWindow - preferred
Maintenance stringWindow - reader
Endpoint string - replication
Source stringIdentifier - storage
Encrypted boolean - {[key: string]: string}
- A map of tags assigned to the resource.
- vpc
Security string[]Group Ids
- arn str
- availability_
zones Sequence[str] - backtrack_
window int - backup_
retention_ intperiod - cluster_
identifier str - cluster_
members Sequence[str] - cluster_
resource_ strid - database_
name str - db_
cluster_ strparameter_ group_ name - db_
subnet_ strgroup_ name - db_
system_ strid - enabled_
cloudwatch_ Sequence[str]logs_ exports - endpoint str
- engine str
- engine_
mode str - engine_
version str - final_
snapshot_ stridentifier - hosted_
zone_ strid - iam_
database_ boolauthentication_ enabled - iam_
roles Sequence[str] - id str
- The provider-assigned unique ID for this managed resource.
- kms_
key_ strid - master_
user_ Sequence[Getsecrets Cluster Master User Secret] - master_
username str - network_
type str - port int
- preferred_
backup_ strwindow - preferred_
maintenance_ strwindow - reader_
endpoint str - replication_
source_ stridentifier - storage_
encrypted bool - Mapping[str, str]
- A map of tags assigned to the resource.
- vpc_
security_ Sequence[str]group_ ids
- arn String
- availability
Zones List<String> - backtrack
Window Number - backup
Retention NumberPeriod - cluster
Identifier String - cluster
Members List<String> - cluster
Resource StringId - database
Name String - db
Cluster StringParameter Group Name - db
Subnet StringGroup Name - db
System StringId - enabled
Cloudwatch List<String>Logs Exports - endpoint String
- engine String
- engine
Mode String - engine
Version String - final
Snapshot StringIdentifier - hosted
Zone StringId - iam
Database BooleanAuthentication Enabled - iam
Roles List<String> - id String
- The provider-assigned unique ID for this managed resource.
- kms
Key StringId - master
User List<Property Map>Secrets - master
Username String - network
Type String - port Number
- preferred
Backup StringWindow - preferred
Maintenance StringWindow - reader
Endpoint String - replication
Source StringIdentifier - storage
Encrypted Boolean - Map<String>
- A map of tags assigned to the resource.
- vpc
Security List<String>Group Ids
Supporting Types
GetClusterMasterUserSecret
- Kms
Key stringId - Secret
Arn string - Secret
Status string
- Kms
Key stringId - Secret
Arn string - Secret
Status string
- kms
Key StringId - secret
Arn String - secret
Status String
- kms
Key stringId - secret
Arn string - secret
Status string
- kms_
key_ strid - secret_
arn str - secret_
status str
- kms
Key StringId - secret
Arn String - secret
Status String
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.