Skip to content
v2.277.0

DatabaseInstanceLookupOptions Struct ​

Properties for looking up an existing DatabaseInstance.

Example ​

ts
declare const myUserRole: iam.Role;

const dbFromLookup = rds.DatabaseInstance.fromLookup(this, 'dbFromLookup', {
  instanceIdentifier: 'instanceId',
});

// Grant a connection
dbFromLookup.grantConnect(myUserRole, 'my-user-id');
python
# my_user_role: iam.Role


db_from_lookup = rds.DatabaseInstance.from_lookup(self, "dbFromLookup",
    instance_identifier="instanceId"
)

# Grant a connection
db_from_lookup.grant_connect(my_user_role, "my-user-id")
java
Role myUserRole;


IDatabaseInstance dbFromLookup = DatabaseInstance.fromLookup(this, "dbFromLookup", DatabaseInstanceLookupOptions.builder()
        .instanceIdentifier("instanceId")
        .build());

// Grant a connection
dbFromLookup.grantConnect(myUserRole, "my-user-id");
csharp
// Install: dotnet add package Amazon.CDK.Lib
Role myUserRole;


var dbFromLookup = DatabaseInstance.FromLookup(this, "dbFromLookup", new DatabaseInstanceLookupOptions {
    InstanceIdentifier = "instanceId"
});

// Grant a connection
dbFromLookup.GrantConnect(myUserRole, "my-user-id");
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var myUserRole Role


dbFromLookup := rds.DatabaseInstance_FromLookup(this, jsii.String("dbFromLookup"), &DatabaseInstanceLookupOptions{
	InstanceIdentifier: jsii.String("instanceId"),
})

// Grant a connection
dbFromLookup.GrantConnect(myUserRole, jsii.String("my-user-id"))

Properties ​

instanceIdentifierstringinstance_identifierstrinstanceIdentifierStringInstanceIdentifierstringInstanceIdentifier*string required #
The instance identifier of the DatabaseInstance.