Class RoleAssociation
Manages an RDS DB Instance association with an IAM Role. Example use cases:
- Amazon RDS Oracle integration with Amazon S3
- Importing Amazon S3 Data into an RDS PostgreSQL DB Instance
To manage the RDS DB Instance IAM Role for Enhanced Monitoring, see the
aws.rds.Instanceresourcemonitoring_role_arnargument instead.
Example Usage
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var example = new Aws.Rds.RoleAssociation("example", new Aws.Rds.RoleAssociationArgs
{
DbInstanceIdentifier = aws_db_instance.Example.Id,
FeatureName = "S3_INTEGRATION",
RoleArn = aws_iam_role.Example.Id,
});
}
}
Inherited Members
Namespace: Pulumi.Aws.Rds
Assembly: Pulumi.Aws.dll
Syntax
public class RoleAssociation : CustomResource
Constructors
View SourceRoleAssociation(String, RoleAssociationArgs, CustomResourceOptions)
Create a RoleAssociation resource with the given unique name, arguments, and options.
Declaration
public RoleAssociation(string name, RoleAssociationArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| RoleAssociationArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceDbInstanceIdentifier
DB Instance Identifier to associate with the IAM Role.
Declaration
public Output<string> DbInstanceIdentifier { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
FeatureName
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.
Declaration
public Output<string> FeatureName { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
RoleArn
Amazon Resource Name (ARN) of the IAM Role to associate with the DB Instance.
Declaration
public Output<string> RoleArn { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Methods
View SourceGet(String, Input<String>, RoleAssociationState, CustomResourceOptions)
Get an existing RoleAssociation resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static RoleAssociation Get(string name, Input<string> id, RoleAssociationState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| RoleAssociationState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| RoleAssociation |