Docs Home
Packages
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
aws.rds.RoleAssociation
Explore with Pulumi AI
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.
Create RoleAssociation Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RoleAssociation(name: string, args: RoleAssociationArgs, opts?: CustomResourceOptions);@overload
def RoleAssociation(resource_name: str,
args: RoleAssociationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RoleAssociation(resource_name: str,
opts: Optional[ResourceOptions] = None,
db_instance_identifier: Optional[str] = None,
feature_name: Optional[str] = None,
role_arn: Optional[str] = None)func NewRoleAssociation(ctx *Context, name string, args RoleAssociationArgs, opts ...ResourceOption) (*RoleAssociation, error)public RoleAssociation(string name, RoleAssociationArgs args, CustomResourceOptions? opts = null)
public RoleAssociation(String name, RoleAssociationArgs args)
public RoleAssociation(String name, RoleAssociationArgs args, CustomResourceOptions options)
type: aws:rds:RoleAssociation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args RoleAssociationArgs
- 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 RoleAssociationArgs
- 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 RoleAssociationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RoleAssociationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RoleAssociationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var awsRoleAssociationResource = new Aws.Rds.RoleAssociation("awsRoleAssociationResource", new()
{
DbInstanceIdentifier = "string",
FeatureName = "string",
RoleArn = "string",
});
example, err := rds.NewRoleAssociation(ctx, "awsRoleAssociationResource", &rds.RoleAssociationArgs{
DbInstanceIdentifier: pulumi.String("string"),
FeatureName: pulumi.String("string"),
RoleArn: pulumi.String("string"),
})
var awsRoleAssociationResource = new RoleAssociation("awsRoleAssociationResource", RoleAssociationArgs.builder()
.dbInstanceIdentifier("string")
.featureName("string")
.roleArn("string")
.build());
aws_role_association_resource = aws.rds.RoleAssociation("awsRoleAssociationResource",
db_instance_identifier="string",
feature_name="string",
role_arn="string")
const awsRoleAssociationResource = new aws.rds.RoleAssociation("awsRoleAssociationResource", {
dbInstanceIdentifier: "string",
featureName: "string",
roleArn: "string",
});
type: aws:rds:RoleAssociation
properties:
dbInstanceIdentifier: string
featureName: string
roleArn: string
RoleAssociation 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 RoleAssociation resource accepts the following input properties:
- Db
Instance stringIdentifier - DB Instance Identifier to associate with the IAM Role.
- Feature
Name 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
SupportedFeatureNameslist returned by AWS CLI rds describe-db-engine-versions. - Role
Arn string - Amazon Resource Name (ARN) of the IAM Role to associate with the DB Instance.
- Db
Instance stringIdentifier - DB Instance Identifier to associate with the IAM Role.
- Feature
Name 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
SupportedFeatureNameslist returned by AWS CLI rds describe-db-engine-versions. - Role
Arn string - Amazon Resource Name (ARN) of the IAM Role to associate with the DB Instance.
- db
Instance StringIdentifier - DB Instance Identifier to associate with the IAM Role.
- feature
Name 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
SupportedFeatureNameslist returned by AWS CLI rds describe-db-engine-versions. - role
Arn String - Amazon Resource Name (ARN) of the IAM Role to associate with the DB Instance.
- db
Instance stringIdentifier - DB Instance Identifier to associate with the IAM Role.
- feature
Name 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
SupportedFeatureNameslist returned by AWS CLI rds describe-db-engine-versions. - role
Arn string - Amazon Resource Name (ARN) of the IAM Role to associate with the DB Instance.
- db_
instance_ stridentifier - DB Instance 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
SupportedFeatureNameslist 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 Instance.
- db
Instance StringIdentifier - DB Instance Identifier to associate with the IAM Role.
- feature
Name 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
SupportedFeatureNameslist returned by AWS CLI rds describe-db-engine-versions. - role
Arn String - Amazon Resource Name (ARN) of the IAM Role to associate with the DB Instance.
Outputs
All input properties are implicitly available as output properties. Additionally, the RoleAssociation 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 Existing RoleAssociation Resource
Get an existing RoleAssociation 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?: RoleAssociationState, opts?: CustomResourceOptions): RoleAssociation@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
db_instance_identifier: Optional[str] = None,
feature_name: Optional[str] = None,
role_arn: Optional[str] = None) -> RoleAssociationfunc GetRoleAssociation(ctx *Context, name string, id IDInput, state *RoleAssociationState, opts ...ResourceOption) (*RoleAssociation, error)public static RoleAssociation Get(string name, Input<string> id, RoleAssociationState? state, CustomResourceOptions? opts = null)public static RoleAssociation get(String name, Output<String> id, RoleAssociationState 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.
- Db
Instance stringIdentifier - DB Instance Identifier to associate with the IAM Role.
- Feature
Name 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
SupportedFeatureNameslist returned by AWS CLI rds describe-db-engine-versions. - Role
Arn string - Amazon Resource Name (ARN) of the IAM Role to associate with the DB Instance.
- Db
Instance stringIdentifier - DB Instance Identifier to associate with the IAM Role.
- Feature
Name 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
SupportedFeatureNameslist returned by AWS CLI rds describe-db-engine-versions. - Role
Arn string - Amazon Resource Name (ARN) of the IAM Role to associate with the DB Instance.
- db
Instance StringIdentifier - DB Instance Identifier to associate with the IAM Role.
- feature
Name 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
SupportedFeatureNameslist returned by AWS CLI rds describe-db-engine-versions. - role
Arn String - Amazon Resource Name (ARN) of the IAM Role to associate with the DB Instance.
- db
Instance stringIdentifier - DB Instance Identifier to associate with the IAM Role.
- feature
Name 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
SupportedFeatureNameslist returned by AWS CLI rds describe-db-engine-versions. - role
Arn string - Amazon Resource Name (ARN) of the IAM Role to associate with the DB Instance.
- db_
instance_ stridentifier - DB Instance 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
SupportedFeatureNameslist 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 Instance.
- db
Instance StringIdentifier - DB Instance Identifier to associate with the IAM Role.
- feature
Name 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
SupportedFeatureNameslist returned by AWS CLI rds describe-db-engine-versions. - role
Arn String - Amazon Resource Name (ARN) of the IAM Role to associate with the DB Instance.
Import
Using pulumi import, import aws_db_instance_role_association using the DB Instance Identifier and IAM Role ARN separated by a comma (,). For example:
$ pulumi import aws:rds/roleAssociation:RoleAssociation example my-db-instance,arn:aws:iam::123456789012:role/my-role
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.