ClusterRoleAssociation class

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.rds.ClusterRoleAssociation("example", {
    dbClusterIdentifier: exampleAwsRdsCluster.id,
    featureName: "S3_INTEGRATION",
    roleArn: exampleAwsIamRole.arn,
});
import pulumi
import pulumi_aws as aws

example = aws.rds.ClusterRoleAssociation("example",
    db_cluster_identifier=example_aws_rds_cluster["id"],
    feature_name="S3_INTEGRATION",
    role_arn=example_aws_iam_role["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Rds.ClusterRoleAssociation("example", new()
    {
        DbClusterIdentifier = exampleAwsRdsCluster.Id,
        FeatureName = "S3_INTEGRATION",
        RoleArn = exampleAwsIamRole.Arn,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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(exampleAwsRdsCluster.Id),
			FeatureName:         pulumi.String("S3_INTEGRATION"),
			RoleArn:             pulumi.Any(exampleAwsIamRole.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_rds_clusterroleassociation" "example" {
  db_cluster_identifier = exampleAwsRdsCluster.id
  feature_name          = "S3_INTEGRATION"
  role_arn              = exampleAwsIamRole.arn
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.ClusterRoleAssociation;
import com.pulumi.aws.rds.ClusterRoleAssociationArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        var example = new ClusterRoleAssociation("example", ClusterRoleAssociationArgs.builder()
            .dbClusterIdentifier(exampleAwsRdsCluster.id())
            .featureName("S3_INTEGRATION")
            .roleArn(exampleAwsIamRole.arn())
            .build());

    }
}
resources:
  example:
    type: aws:rds:ClusterRoleAssociation
    properties:
      dbClusterIdentifier: ${exampleAwsRdsCluster.id}
      featureName: S3_INTEGRATION
      roleArn: ${exampleAwsIamRole.arn}

Import

Using pulumi import, import aws.rds.ClusterRoleAssociation using the DB Cluster Identifier and IAM Role ARN separated by a comma (,). For example:

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

Constructors

ClusterRoleAssociation(String name, {ClusterRoleAssociationArgs? args, CustomResourceOptions? options})
Creates a new ClusterRoleAssociation. name The Pulumi resource name. args Arguments used to configure this ClusterRoleAssociation. The set of arguments for ClusterRoleAssociation. options Resource options controlling this resource's behavior.
ClusterRoleAssociation.reference(String urn)
Creates a typed reference to an existing ClusterRoleAssociation resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
dbClusterIdentifier ↔ Output<String>
DB Cluster Identifier to associate with the IAM Role.
latefinal
featureName ↔ Output<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.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
roleArn ↔ Output<String>
ARN of the IAM Role to associate with the DB Cluster.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ClusterRoleAssociationState? state, CustomResourceOptions? options}) → ClusterRoleAssociation
Gets an existing ClusterRoleAssociation resource's state with the given name and id.