github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/rds/getCluster.go (about)

     1  // Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
     2  // *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
     3  
     4  package rds
     5  
     6  import (
     7  	"context"
     8  	"reflect"
     9  
    10  	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
    11  	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    12  )
    13  
    14  // Provides information about an RDS cluster.
    15  //
    16  // ## Example Usage
    17  //
    18  // <!--Start PulumiCodeChooser -->
    19  // ```go
    20  // package main
    21  //
    22  // import (
    23  //
    24  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
    25  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    26  //
    27  // )
    28  //
    29  //	func main() {
    30  //		pulumi.Run(func(ctx *pulumi.Context) error {
    31  //			_, err := rds.LookupCluster(ctx, &rds.LookupClusterArgs{
    32  //				ClusterIdentifier: "clusterName",
    33  //			}, nil)
    34  //			if err != nil {
    35  //				return err
    36  //			}
    37  //			return nil
    38  //		})
    39  //	}
    40  //
    41  // ```
    42  // <!--End PulumiCodeChooser -->
    43  func LookupCluster(ctx *pulumi.Context, args *LookupClusterArgs, opts ...pulumi.InvokeOption) (*LookupClusterResult, error) {
    44  	opts = internal.PkgInvokeDefaultOpts(opts)
    45  	var rv LookupClusterResult
    46  	err := ctx.Invoke("aws:rds/getCluster:getCluster", args, &rv, opts...)
    47  	if err != nil {
    48  		return nil, err
    49  	}
    50  	return &rv, nil
    51  }
    52  
    53  // A collection of arguments for invoking getCluster.
    54  type LookupClusterArgs struct {
    55  	// Cluster identifier of the RDS cluster.
    56  	ClusterIdentifier string `pulumi:"clusterIdentifier"`
    57  	// A map of tags assigned to the resource.
    58  	Tags map[string]string `pulumi:"tags"`
    59  }
    60  
    61  // A collection of values returned by getCluster.
    62  type LookupClusterResult struct {
    63  	Arn                              string   `pulumi:"arn"`
    64  	AvailabilityZones                []string `pulumi:"availabilityZones"`
    65  	BacktrackWindow                  int      `pulumi:"backtrackWindow"`
    66  	BackupRetentionPeriod            int      `pulumi:"backupRetentionPeriod"`
    67  	ClusterIdentifier                string   `pulumi:"clusterIdentifier"`
    68  	ClusterMembers                   []string `pulumi:"clusterMembers"`
    69  	ClusterResourceId                string   `pulumi:"clusterResourceId"`
    70  	DatabaseName                     string   `pulumi:"databaseName"`
    71  	DbClusterParameterGroupName      string   `pulumi:"dbClusterParameterGroupName"`
    72  	DbSubnetGroupName                string   `pulumi:"dbSubnetGroupName"`
    73  	DbSystemId                       string   `pulumi:"dbSystemId"`
    74  	EnabledCloudwatchLogsExports     []string `pulumi:"enabledCloudwatchLogsExports"`
    75  	Endpoint                         string   `pulumi:"endpoint"`
    76  	Engine                           string   `pulumi:"engine"`
    77  	EngineMode                       string   `pulumi:"engineMode"`
    78  	EngineVersion                    string   `pulumi:"engineVersion"`
    79  	FinalSnapshotIdentifier          string   `pulumi:"finalSnapshotIdentifier"`
    80  	HostedZoneId                     string   `pulumi:"hostedZoneId"`
    81  	IamDatabaseAuthenticationEnabled bool     `pulumi:"iamDatabaseAuthenticationEnabled"`
    82  	IamRoles                         []string `pulumi:"iamRoles"`
    83  	// The provider-assigned unique ID for this managed resource.
    84  	Id                          string                       `pulumi:"id"`
    85  	KmsKeyId                    string                       `pulumi:"kmsKeyId"`
    86  	MasterUserSecrets           []GetClusterMasterUserSecret `pulumi:"masterUserSecrets"`
    87  	MasterUsername              string                       `pulumi:"masterUsername"`
    88  	NetworkType                 string                       `pulumi:"networkType"`
    89  	Port                        int                          `pulumi:"port"`
    90  	PreferredBackupWindow       string                       `pulumi:"preferredBackupWindow"`
    91  	PreferredMaintenanceWindow  string                       `pulumi:"preferredMaintenanceWindow"`
    92  	ReaderEndpoint              string                       `pulumi:"readerEndpoint"`
    93  	ReplicationSourceIdentifier string                       `pulumi:"replicationSourceIdentifier"`
    94  	StorageEncrypted            bool                         `pulumi:"storageEncrypted"`
    95  	// A map of tags assigned to the resource.
    96  	Tags                map[string]string `pulumi:"tags"`
    97  	VpcSecurityGroupIds []string          `pulumi:"vpcSecurityGroupIds"`
    98  }
    99  
   100  func LookupClusterOutput(ctx *pulumi.Context, args LookupClusterOutputArgs, opts ...pulumi.InvokeOption) LookupClusterResultOutput {
   101  	return pulumi.ToOutputWithContext(context.Background(), args).
   102  		ApplyT(func(v interface{}) (LookupClusterResult, error) {
   103  			args := v.(LookupClusterArgs)
   104  			r, err := LookupCluster(ctx, &args, opts...)
   105  			var s LookupClusterResult
   106  			if r != nil {
   107  				s = *r
   108  			}
   109  			return s, err
   110  		}).(LookupClusterResultOutput)
   111  }
   112  
   113  // A collection of arguments for invoking getCluster.
   114  type LookupClusterOutputArgs struct {
   115  	// Cluster identifier of the RDS cluster.
   116  	ClusterIdentifier pulumi.StringInput `pulumi:"clusterIdentifier"`
   117  	// A map of tags assigned to the resource.
   118  	Tags pulumi.StringMapInput `pulumi:"tags"`
   119  }
   120  
   121  func (LookupClusterOutputArgs) ElementType() reflect.Type {
   122  	return reflect.TypeOf((*LookupClusterArgs)(nil)).Elem()
   123  }
   124  
   125  // A collection of values returned by getCluster.
   126  type LookupClusterResultOutput struct{ *pulumi.OutputState }
   127  
   128  func (LookupClusterResultOutput) ElementType() reflect.Type {
   129  	return reflect.TypeOf((*LookupClusterResult)(nil)).Elem()
   130  }
   131  
   132  func (o LookupClusterResultOutput) ToLookupClusterResultOutput() LookupClusterResultOutput {
   133  	return o
   134  }
   135  
   136  func (o LookupClusterResultOutput) ToLookupClusterResultOutputWithContext(ctx context.Context) LookupClusterResultOutput {
   137  	return o
   138  }
   139  
   140  func (o LookupClusterResultOutput) Arn() pulumi.StringOutput {
   141  	return o.ApplyT(func(v LookupClusterResult) string { return v.Arn }).(pulumi.StringOutput)
   142  }
   143  
   144  func (o LookupClusterResultOutput) AvailabilityZones() pulumi.StringArrayOutput {
   145  	return o.ApplyT(func(v LookupClusterResult) []string { return v.AvailabilityZones }).(pulumi.StringArrayOutput)
   146  }
   147  
   148  func (o LookupClusterResultOutput) BacktrackWindow() pulumi.IntOutput {
   149  	return o.ApplyT(func(v LookupClusterResult) int { return v.BacktrackWindow }).(pulumi.IntOutput)
   150  }
   151  
   152  func (o LookupClusterResultOutput) BackupRetentionPeriod() pulumi.IntOutput {
   153  	return o.ApplyT(func(v LookupClusterResult) int { return v.BackupRetentionPeriod }).(pulumi.IntOutput)
   154  }
   155  
   156  func (o LookupClusterResultOutput) ClusterIdentifier() pulumi.StringOutput {
   157  	return o.ApplyT(func(v LookupClusterResult) string { return v.ClusterIdentifier }).(pulumi.StringOutput)
   158  }
   159  
   160  func (o LookupClusterResultOutput) ClusterMembers() pulumi.StringArrayOutput {
   161  	return o.ApplyT(func(v LookupClusterResult) []string { return v.ClusterMembers }).(pulumi.StringArrayOutput)
   162  }
   163  
   164  func (o LookupClusterResultOutput) ClusterResourceId() pulumi.StringOutput {
   165  	return o.ApplyT(func(v LookupClusterResult) string { return v.ClusterResourceId }).(pulumi.StringOutput)
   166  }
   167  
   168  func (o LookupClusterResultOutput) DatabaseName() pulumi.StringOutput {
   169  	return o.ApplyT(func(v LookupClusterResult) string { return v.DatabaseName }).(pulumi.StringOutput)
   170  }
   171  
   172  func (o LookupClusterResultOutput) DbClusterParameterGroupName() pulumi.StringOutput {
   173  	return o.ApplyT(func(v LookupClusterResult) string { return v.DbClusterParameterGroupName }).(pulumi.StringOutput)
   174  }
   175  
   176  func (o LookupClusterResultOutput) DbSubnetGroupName() pulumi.StringOutput {
   177  	return o.ApplyT(func(v LookupClusterResult) string { return v.DbSubnetGroupName }).(pulumi.StringOutput)
   178  }
   179  
   180  func (o LookupClusterResultOutput) DbSystemId() pulumi.StringOutput {
   181  	return o.ApplyT(func(v LookupClusterResult) string { return v.DbSystemId }).(pulumi.StringOutput)
   182  }
   183  
   184  func (o LookupClusterResultOutput) EnabledCloudwatchLogsExports() pulumi.StringArrayOutput {
   185  	return o.ApplyT(func(v LookupClusterResult) []string { return v.EnabledCloudwatchLogsExports }).(pulumi.StringArrayOutput)
   186  }
   187  
   188  func (o LookupClusterResultOutput) Endpoint() pulumi.StringOutput {
   189  	return o.ApplyT(func(v LookupClusterResult) string { return v.Endpoint }).(pulumi.StringOutput)
   190  }
   191  
   192  func (o LookupClusterResultOutput) Engine() pulumi.StringOutput {
   193  	return o.ApplyT(func(v LookupClusterResult) string { return v.Engine }).(pulumi.StringOutput)
   194  }
   195  
   196  func (o LookupClusterResultOutput) EngineMode() pulumi.StringOutput {
   197  	return o.ApplyT(func(v LookupClusterResult) string { return v.EngineMode }).(pulumi.StringOutput)
   198  }
   199  
   200  func (o LookupClusterResultOutput) EngineVersion() pulumi.StringOutput {
   201  	return o.ApplyT(func(v LookupClusterResult) string { return v.EngineVersion }).(pulumi.StringOutput)
   202  }
   203  
   204  func (o LookupClusterResultOutput) FinalSnapshotIdentifier() pulumi.StringOutput {
   205  	return o.ApplyT(func(v LookupClusterResult) string { return v.FinalSnapshotIdentifier }).(pulumi.StringOutput)
   206  }
   207  
   208  func (o LookupClusterResultOutput) HostedZoneId() pulumi.StringOutput {
   209  	return o.ApplyT(func(v LookupClusterResult) string { return v.HostedZoneId }).(pulumi.StringOutput)
   210  }
   211  
   212  func (o LookupClusterResultOutput) IamDatabaseAuthenticationEnabled() pulumi.BoolOutput {
   213  	return o.ApplyT(func(v LookupClusterResult) bool { return v.IamDatabaseAuthenticationEnabled }).(pulumi.BoolOutput)
   214  }
   215  
   216  func (o LookupClusterResultOutput) IamRoles() pulumi.StringArrayOutput {
   217  	return o.ApplyT(func(v LookupClusterResult) []string { return v.IamRoles }).(pulumi.StringArrayOutput)
   218  }
   219  
   220  // The provider-assigned unique ID for this managed resource.
   221  func (o LookupClusterResultOutput) Id() pulumi.StringOutput {
   222  	return o.ApplyT(func(v LookupClusterResult) string { return v.Id }).(pulumi.StringOutput)
   223  }
   224  
   225  func (o LookupClusterResultOutput) KmsKeyId() pulumi.StringOutput {
   226  	return o.ApplyT(func(v LookupClusterResult) string { return v.KmsKeyId }).(pulumi.StringOutput)
   227  }
   228  
   229  func (o LookupClusterResultOutput) MasterUserSecrets() GetClusterMasterUserSecretArrayOutput {
   230  	return o.ApplyT(func(v LookupClusterResult) []GetClusterMasterUserSecret { return v.MasterUserSecrets }).(GetClusterMasterUserSecretArrayOutput)
   231  }
   232  
   233  func (o LookupClusterResultOutput) MasterUsername() pulumi.StringOutput {
   234  	return o.ApplyT(func(v LookupClusterResult) string { return v.MasterUsername }).(pulumi.StringOutput)
   235  }
   236  
   237  func (o LookupClusterResultOutput) NetworkType() pulumi.StringOutput {
   238  	return o.ApplyT(func(v LookupClusterResult) string { return v.NetworkType }).(pulumi.StringOutput)
   239  }
   240  
   241  func (o LookupClusterResultOutput) Port() pulumi.IntOutput {
   242  	return o.ApplyT(func(v LookupClusterResult) int { return v.Port }).(pulumi.IntOutput)
   243  }
   244  
   245  func (o LookupClusterResultOutput) PreferredBackupWindow() pulumi.StringOutput {
   246  	return o.ApplyT(func(v LookupClusterResult) string { return v.PreferredBackupWindow }).(pulumi.StringOutput)
   247  }
   248  
   249  func (o LookupClusterResultOutput) PreferredMaintenanceWindow() pulumi.StringOutput {
   250  	return o.ApplyT(func(v LookupClusterResult) string { return v.PreferredMaintenanceWindow }).(pulumi.StringOutput)
   251  }
   252  
   253  func (o LookupClusterResultOutput) ReaderEndpoint() pulumi.StringOutput {
   254  	return o.ApplyT(func(v LookupClusterResult) string { return v.ReaderEndpoint }).(pulumi.StringOutput)
   255  }
   256  
   257  func (o LookupClusterResultOutput) ReplicationSourceIdentifier() pulumi.StringOutput {
   258  	return o.ApplyT(func(v LookupClusterResult) string { return v.ReplicationSourceIdentifier }).(pulumi.StringOutput)
   259  }
   260  
   261  func (o LookupClusterResultOutput) StorageEncrypted() pulumi.BoolOutput {
   262  	return o.ApplyT(func(v LookupClusterResult) bool { return v.StorageEncrypted }).(pulumi.BoolOutput)
   263  }
   264  
   265  // A map of tags assigned to the resource.
   266  func (o LookupClusterResultOutput) Tags() pulumi.StringMapOutput {
   267  	return o.ApplyT(func(v LookupClusterResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
   268  }
   269  
   270  func (o LookupClusterResultOutput) VpcSecurityGroupIds() pulumi.StringArrayOutput {
   271  	return o.ApplyT(func(v LookupClusterResult) []string { return v.VpcSecurityGroupIds }).(pulumi.StringArrayOutput)
   272  }
   273  
   274  func init() {
   275  	pulumi.RegisterOutputType(LookupClusterResultOutput{})
   276  }