AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.4.0 published on Wednesday, May 4, 2022 by Pulumi

ClusterRoleAssociation

Manages a RDS DB Cluster association with an IAM Role. Example use cases:

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Rds.ClusterRoleAssociation("example", new Aws.Rds.ClusterRoleAssociationArgs
        {
            DbClusterIdentifier = aws_rds_cluster.Example.Id,
            FeatureName = "S3_INTEGRATION",
            RoleArn = aws_iam_role.Example.Id,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds.NewClusterRoleAssociation(ctx, "example", &rds.ClusterRoleAssociationArgs{
			DbClusterIdentifier: pulumi.Any(aws_rds_cluster.Example.Id),
			FeatureName:         pulumi.String("S3_INTEGRATION"),
			RoleArn:             pulumi.Any(aws_iam_role.Example.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ClusterRoleAssociation("example", ClusterRoleAssociationArgs.builder()        
            .dbClusterIdentifier(aws_rds_cluster.getExample().getId())
            .featureName("S3_INTEGRATION")
            .roleArn(aws_iam_role.getExample().getId())
            .build());

        }
}
import pulumi
import pulumi_aws as aws

example = aws.rds.ClusterRoleAssociation("example",
    db_cluster_identifier=aws_rds_cluster["example"]["id"],
    feature_name="S3_INTEGRATION",
    role_arn=aws_iam_role["example"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.rds.ClusterRoleAssociation("example", {
    dbClusterIdentifier: aws_rds_cluster.example.id,
    featureName: "S3_INTEGRATION",
    roleArn: aws_iam_role.example.id,
});
resources:
  example:
    type: aws:rds:ClusterRoleAssociation
    properties:
      dbClusterIdentifier: ${aws_rds_cluster.example.id}
      featureName: S3_INTEGRATION
      roleArn: ${aws_iam_role.example.id}

Create a ClusterRoleAssociation Resource

new ClusterRoleAssociation(name: string, args: ClusterRoleAssociationArgs, opts?: CustomResourceOptions);
@overload
def ClusterRoleAssociation(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           db_cluster_identifier: Optional[str] = None,
                           feature_name: Optional[str] = None,
                           role_arn: Optional[str] = None)
@overload
def ClusterRoleAssociation(resource_name: str,
                           args: ClusterRoleAssociationArgs,
                           opts: Optional[ResourceOptions] = None)
func NewClusterRoleAssociation(ctx *Context, name string, args ClusterRoleAssociationArgs, opts ...ResourceOption) (*ClusterRoleAssociation, error)
public ClusterRoleAssociation(string name, ClusterRoleAssociationArgs args, CustomResourceOptions? opts = null)
public ClusterRoleAssociation(String name, ClusterRoleAssociationArgs args)
public ClusterRoleAssociation(String name, ClusterRoleAssociationArgs args, CustomResourceOptions options)
type: aws:rds:ClusterRoleAssociation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ClusterRoleAssociationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ClusterRoleAssociationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ClusterRoleAssociationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ClusterRoleAssociationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ClusterRoleAssociationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ClusterRoleAssociation Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ClusterRoleAssociation resource accepts the following input properties:

DbClusterIdentifier string

DB Cluster Identifier to associate with the IAM Role.

FeatureName string

Name of the feature for association. This can be found in the AWS documentation relevant to the integration or a full list is available in the SupportedFeatureNames list returned by AWS CLI rds describe-db-engine-versions.

RoleArn string

Amazon Resource Name (ARN) of the IAM Role to associate with the DB Cluster.

DbClusterIdentifier string

DB Cluster Identifier to associate with the IAM Role.

FeatureName string

Name of the feature for association. This can be found in the AWS documentation relevant to the integration or a full list is available in the SupportedFeatureNames list returned by AWS CLI rds describe-db-engine-versions.

RoleArn string

Amazon Resource Name (ARN) of the IAM Role to associate with the DB Cluster.

dbClusterIdentifier String

DB Cluster Identifier to associate with the IAM Role.

featureName String

Name of the feature for association. This can be found in the AWS documentation relevant to the integration or a full list is available in the SupportedFeatureNames list returned by AWS CLI rds describe-db-engine-versions.

roleArn String

Amazon Resource Name (ARN) of the IAM Role to associate with the DB Cluster.

dbClusterIdentifier string

DB Cluster Identifier to associate with the IAM Role.

featureName string

Name of the feature for association. This can be found in the AWS documentation relevant to the integration or a full list is available in the SupportedFeatureNames list returned by AWS CLI rds describe-db-engine-versions.

roleArn string

Amazon Resource Name (ARN) of the IAM Role to associate with the DB Cluster.

db_cluster_identifier str

DB Cluster Identifier to associate with the IAM Role.

feature_name str

Name of the feature for association. This can be found in the AWS documentation relevant to the integration or a full list is available in the SupportedFeatureNames list returned by AWS CLI rds describe-db-engine-versions.

role_arn str

Amazon Resource Name (ARN) of the IAM Role to associate with the DB Cluster.

dbClusterIdentifier String

DB Cluster Identifier to associate with the IAM Role.

featureName String

Name of the feature for association. This can be found in the AWS documentation relevant to the integration or a full list is available in the SupportedFeatureNames list returned by AWS CLI rds describe-db-engine-versions.

roleArn String

Amazon Resource Name (ARN) of the IAM Role to associate with the DB Cluster.

Outputs

All input properties are implicitly available as output properties. Additionally, the ClusterRoleAssociation resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up an Existing ClusterRoleAssociation Resource

Get an existing ClusterRoleAssociation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ClusterRoleAssociationState, opts?: CustomResourceOptions): ClusterRoleAssociation
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        db_cluster_identifier: Optional[str] = None,
        feature_name: Optional[str] = None,
        role_arn: Optional[str] = None) -> ClusterRoleAssociation
func GetClusterRoleAssociation(ctx *Context, name string, id IDInput, state *ClusterRoleAssociationState, opts ...ResourceOption) (*ClusterRoleAssociation, error)
public static ClusterRoleAssociation Get(string name, Input<string> id, ClusterRoleAssociationState? state, CustomResourceOptions? opts = null)
public static ClusterRoleAssociation get(String name, Output<String> id, ClusterRoleAssociationState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
DbClusterIdentifier string

DB Cluster Identifier to associate with the IAM Role.

FeatureName string

Name of the feature for association. This can be found in the AWS documentation relevant to the integration or a full list is available in the SupportedFeatureNames list returned by AWS CLI rds describe-db-engine-versions.

RoleArn string

Amazon Resource Name (ARN) of the IAM Role to associate with the DB Cluster.

DbClusterIdentifier string

DB Cluster Identifier to associate with the IAM Role.

FeatureName string

Name of the feature for association. This can be found in the AWS documentation relevant to the integration or a full list is available in the SupportedFeatureNames list returned by AWS CLI rds describe-db-engine-versions.

RoleArn string

Amazon Resource Name (ARN) of the IAM Role to associate with the DB Cluster.

dbClusterIdentifier String

DB Cluster Identifier to associate with the IAM Role.

featureName String

Name of the feature for association. This can be found in the AWS documentation relevant to the integration or a full list is available in the SupportedFeatureNames list returned by AWS CLI rds describe-db-engine-versions.

roleArn String

Amazon Resource Name (ARN) of the IAM Role to associate with the DB Cluster.

dbClusterIdentifier string

DB Cluster Identifier to associate with the IAM Role.

featureName string

Name of the feature for association. This can be found in the AWS documentation relevant to the integration or a full list is available in the SupportedFeatureNames list returned by AWS CLI rds describe-db-engine-versions.

roleArn string

Amazon Resource Name (ARN) of the IAM Role to associate with the DB Cluster.

db_cluster_identifier str

DB Cluster Identifier to associate with the IAM Role.

feature_name str

Name of the feature for association. This can be found in the AWS documentation relevant to the integration or a full list is available in the SupportedFeatureNames list returned by AWS CLI rds describe-db-engine-versions.

role_arn str

Amazon Resource Name (ARN) of the IAM Role to associate with the DB Cluster.

dbClusterIdentifier String

DB Cluster Identifier to associate with the IAM Role.

featureName String

Name of the feature for association. This can be found in the AWS documentation relevant to the integration or a full list is available in the SupportedFeatureNames list returned by AWS CLI rds describe-db-engine-versions.

roleArn String

Amazon Resource Name (ARN) of the IAM Role to associate with the DB Cluster.

Import

aws_rds_cluster_role_association can be imported using the DB Cluster Identifier and IAM Role ARN separated by a comma (,), e.g.,

 $ pulumi import aws:rds/clusterRoleAssociation:ClusterRoleAssociation example my-db-cluster,arn:aws:iam::123456789012:role/my-role

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.