Class DatabaseSecret

A database secret.

Inheritance
object
Resource
Secret
DatabaseSecret
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class DatabaseSecret : Secret, ISecret, IResource, IConstruct, IDependable
Syntax (vb)
Public Class DatabaseSecret Inherits Secret Implements ISecret, IResource, IConstruct, IDependable
Remarks

Resource: AWS::SecretsManager::Secret

ExampleMetadata: infused

Examples
// Build a data source for AppSync to access the database.
             GraphqlApi api;
             // Create username and password secret for DB Cluster
             var secret = new DatabaseSecret(this, "AuroraSecret", new DatabaseSecretProps {
                 Username = "clusteradmin"
             });

             // The VPC to place the cluster in
             var vpc = new Vpc(this, "AuroraVpc");

             // Create the serverless cluster, provide all values needed to customise the database.
             var cluster = new ServerlessCluster(this, "AuroraCluster", new ServerlessClusterProps {
                 Engine = DatabaseClusterEngine.AURORA_MYSQL,
                 Vpc = vpc,
                 Credentials = new Dictionary<string, string> { { "username", "clusteradmin" } },
                 ClusterIdentifier = "db-endpoint-test",
                 DefaultDatabaseName = "demos"
             });
             var rdsDS = api.AddRdsDataSource("rds", cluster, secret, "demos");

             // Set up a resolver for an RDS query.
             rdsDS.CreateResolver("QueryGetDemosRdsResolver", new BaseResolverProps {
                 TypeName = "Query",
                 FieldName = "getDemosRds",
                 RequestMappingTemplate = MappingTemplate.FromString(@"
                   {
                     ""version"": ""2018-05-29"",
                     ""statements"": [
                       ""SELECT * FROM demos""
                     ]
                   }
                   "),
                 ResponseMappingTemplate = MappingTemplate.FromString(@"
                     $utils.toJson($utils.rds.toJsonObject($ctx.result)[0])
                   ")
             });

             // Set up a resolver for an RDS mutation.
             rdsDS.CreateResolver("MutationAddDemoRdsResolver", new BaseResolverProps {
                 TypeName = "Mutation",
                 FieldName = "addDemoRds",
                 RequestMappingTemplate = MappingTemplate.FromString(@"
                   {
                     ""version"": ""2018-05-29"",
                     ""statements"": [
                       ""INSERT INTO demos VALUES (:id, :version)"",
                       ""SELECT * WHERE id = :id""
                     ],
                     ""variableMap"": {
                       "":id"": $util.toJson($util.autoId()),
                       "":version"": $util.toJson($ctx.args.version)
                     }
                   }
                   "),
                 ResponseMappingTemplate = MappingTemplate.FromString(@"
                     $utils.toJson($utils.rds.toJsonObject($ctx.result)[1][0])
                   ")
             });

Synopsis

Constructors

DatabaseSecret(Construct, string, IDatabaseSecretProps)

A database secret.

Properties

PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructors

DatabaseSecret(Construct, string, IDatabaseSecretProps)

A database secret.

public DatabaseSecret(Construct scope, string id, IDatabaseSecretProps props)
Parameters
scope Construct
id string
props IDatabaseSecretProps
Remarks

Resource: AWS::SecretsManager::Secret

ExampleMetadata: infused

Examples
// Build a data source for AppSync to access the database.
             GraphqlApi api;
             // Create username and password secret for DB Cluster
             var secret = new DatabaseSecret(this, "AuroraSecret", new DatabaseSecretProps {
                 Username = "clusteradmin"
             });

             // The VPC to place the cluster in
             var vpc = new Vpc(this, "AuroraVpc");

             // Create the serverless cluster, provide all values needed to customise the database.
             var cluster = new ServerlessCluster(this, "AuroraCluster", new ServerlessClusterProps {
                 Engine = DatabaseClusterEngine.AURORA_MYSQL,
                 Vpc = vpc,
                 Credentials = new Dictionary<string, string> { { "username", "clusteradmin" } },
                 ClusterIdentifier = "db-endpoint-test",
                 DefaultDatabaseName = "demos"
             });
             var rdsDS = api.AddRdsDataSource("rds", cluster, secret, "demos");

             // Set up a resolver for an RDS query.
             rdsDS.CreateResolver("QueryGetDemosRdsResolver", new BaseResolverProps {
                 TypeName = "Query",
                 FieldName = "getDemosRds",
                 RequestMappingTemplate = MappingTemplate.FromString(@"
                   {
                     ""version"": ""2018-05-29"",
                     ""statements"": [
                       ""SELECT * FROM demos""
                     ]
                   }
                   "),
                 ResponseMappingTemplate = MappingTemplate.FromString(@"
                     $utils.toJson($utils.rds.toJsonObject($ctx.result)[0])
                   ")
             });

             // Set up a resolver for an RDS mutation.
             rdsDS.CreateResolver("MutationAddDemoRdsResolver", new BaseResolverProps {
                 TypeName = "Mutation",
                 FieldName = "addDemoRds",
                 RequestMappingTemplate = MappingTemplate.FromString(@"
                   {
                     ""version"": ""2018-05-29"",
                     ""statements"": [
                       ""INSERT INTO demos VALUES (:id, :version)"",
                       ""SELECT * WHERE id = :id""
                     ],
                     ""variableMap"": {
                       "":id"": $util.toJson($util.autoId()),
                       "":version"": $util.toJson($ctx.args.version)
                     }
                   }
                   "),
                 ResponseMappingTemplate = MappingTemplate.FromString(@"
                     $utils.toJson($utils.rds.toJsonObject($ctx.result)[1][0])
                   ")
             });

Properties

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

Resource: AWS::SecretsManager::Secret

ExampleMetadata: infused

Implements

Constructs.IConstruct
Constructs.IDependable