Docs Packages
  1. Packages
  2. Pulumi Nuage
  3. API Docs
  4. aws
  5. ServerlessDatabase
nuage v0.1.1 published on Friday, Mar 17, 2023 by Nuage-Studio
nuage-studio/pulumi-nuage

nuage.aws.ServerlessDatabase

Explore with Pulumi AI

nuage logo
nuage v0.1.1 published on Friday, Mar 17, 2023 by Nuage-Studio
nuage-studio/pulumi-nuage

    The ServerlessDatabase component is a convenient and efficient solution for creating serverless databases using Amazon RDS Aurora. It automatically creates components such as subnet group, security group, security group rules, and RDS cluster, and securely manages the DB credentials. With support for both MySQL and PostgreSQL, it provides a fully configured serverless database resource for your serverless database needs.

    Example Usage

    Basic Example

    Coming soon!

    Coming soon!

    Coming soon!

    import pulumi_nuage as nuage
import pulumi_awsx as awsx


db = nuage.aws.ServerlessDatabase(
    "foo",
    name="serverless-db",
    vpc_id=vpc.id,
    subnet_ids=vpc.private_subnet_ids,
    database_type="mysql",
    database_name="bar",
    master_username="root",
    ip_whitelist=["0.0.0.0/0"],
    skip_final_snapshot=True,
    bastion=nuage.aws.BastionConfigArgs(
        enabled=True,
        subnet_id=vpc.public_subnet_ids[0]
    ),    
)

    Coming soon!

    Coming soon!

    Create ServerlessDatabase Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ServerlessDatabase(name: string, args: ServerlessDatabaseArgs, opts?: CustomResourceOptions);
    @overload
def ServerlessDatabase(resource_name: str,
                       args: ServerlessDatabaseArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def ServerlessDatabase(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       database_name: Optional[str] = None,
                       database_type: Optional[str] = None,
                       master_user_name: Optional[str] = None,
                       subnet_ids: Optional[Sequence[str]] = None,
                       vpc_id: Optional[str] = None,
                       bastion: Optional[BastionConfigArgs] = None,
                       ip_whitelist: Optional[Sequence[str]] = None,
                       skip_final_snapshot: Optional[bool] = None)
    func NewServerlessDatabase(ctx *Context, name string, args ServerlessDatabaseArgs, opts ...ResourceOption) (*ServerlessDatabase, error)
    public ServerlessDatabase(string name, ServerlessDatabaseArgs args, CustomResourceOptions? opts = null)
    public ServerlessDatabase(String name, ServerlessDatabaseArgs args)
public ServerlessDatabase(String name, ServerlessDatabaseArgs args, CustomResourceOptions options)

    type: nuage:aws:ServerlessDatabase
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 ServerlessDatabaseArgs
    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 ServerlessDatabaseArgs
    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 ServerlessDatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServerlessDatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServerlessDatabaseArgs
    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 serverlessDatabaseResource = new Nuage.Aws.ServerlessDatabase("serverlessDatabaseResource", new()
{
    DatabaseName = "string",
    DatabaseType = "string",
    MasterUserName = "string",
    SubnetIds = new[]
    {
        "string",
    },
    VpcId = "string",
    Bastion = new Nuage.Aws.Inputs.BastionConfigArgs
    {
        Enabled = false,
        SubnetId = "string",
    },
    IpWhitelist = new[]
    {
        "string",
    },
    SkipFinalSnapshot = false,
});

    example, err := aws.NewServerlessDatabase(ctx, "serverlessDatabaseResource", &aws.ServerlessDatabaseArgs{
	DatabaseName:   pulumi.String("string"),
	DatabaseType:   pulumi.String("string"),
	MasterUserName: pulumi.String("string"),
	SubnetIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	VpcId: pulumi.String("string"),
	Bastion: &aws.BastionConfigArgs{
		Enabled:  pulumi.Bool(false),
		SubnetId: pulumi.String("string"),
	},
	IpWhitelist: pulumi.StringArray{
		pulumi.String("string"),
	},
	SkipFinalSnapshot: pulumi.Bool(false),
})

    var serverlessDatabaseResource = new ServerlessDatabase("serverlessDatabaseResource", ServerlessDatabaseArgs.builder()
    .databaseName("string")
    .databaseType("string")
    .masterUserName("string")
    .subnetIds("string")
    .vpcId("string")
    .bastion(BastionConfigArgs.builder()
        .enabled(false)
        .subnetId("string")
        .build())
    .ipWhitelist("string")
    .skipFinalSnapshot(false)
    .build());

    serverless_database_resource = nuage.aws.ServerlessDatabase("serverlessDatabaseResource",
    database_name="string",
    database_type="string",
    master_user_name="string",
    subnet_ids=["string"],
    vpc_id="string",
    bastion=nuage.aws.BastionConfigArgs(
        enabled=False,
        subnet_id="string",
    ),
    ip_whitelist=["string"],
    skip_final_snapshot=False)

    const serverlessDatabaseResource = new nuage.aws.ServerlessDatabase("serverlessDatabaseResource", {
    databaseName: "string",
    databaseType: "string",
    masterUserName: "string",
    subnetIds: ["string"],
    vpcId: "string",
    bastion: {
        enabled: false,
        subnetId: "string",
    },
    ipWhitelist: ["string"],
    skipFinalSnapshot: false,
});

    type: nuage:aws:ServerlessDatabase
properties:
    bastion:
        enabled: false
        subnetId: string
    databaseName: string
    databaseType: string
    ipWhitelist:
        - string
    masterUserName: string
    skipFinalSnapshot: false
    subnetIds:
        - string
    vpcId: string

    ServerlessDatabase 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 ServerlessDatabase resource accepts the following input properties:

    DatabaseName string
    Name of the database.
    DatabaseType string
    Database type. mysql or postgresql
    MasterUserName string
    Master user name of the db.
    SubnetIds List<string>
    List of subnet ip addresses. If you want your database will be accessible from the internet, it should be public (vpc.public_subnet_ids). Otherwise, you can use private subnets (vpc.private_subnet_ids).
    VpcId string
    Vpc id.
    Bastion BastionConfig
    Configure the bastion host for connecting the db.
    IpWhitelist List<string>
    List of whitelisted IP addresses. If not specified, it will be public 0.0.0.0/0
    SkipFinalSnapshot bool
    Determines whether a final DB snapshot is created before the DB instance is deleted. Defaults to false
    DatabaseName string
    Name of the database.
    DatabaseType string
    Database type. mysql or postgresql
    MasterUserName string
    Master user name of the db.
    SubnetIds []string
    List of subnet ip addresses. If you want your database will be accessible from the internet, it should be public (vpc.public_subnet_ids). Otherwise, you can use private subnets (vpc.private_subnet_ids).
    VpcId string
    Vpc id.
    Bastion BastionConfigArgs
    Configure the bastion host for connecting the db.
    IpWhitelist []string
    List of whitelisted IP addresses. If not specified, it will be public 0.0.0.0/0
    SkipFinalSnapshot bool
    Determines whether a final DB snapshot is created before the DB instance is deleted. Defaults to false
    databaseName String
    Name of the database.
    databaseType String
    Database type. mysql or postgresql
    masterUserName String
    Master user name of the db.
    subnetIds List<String>
    List of subnet ip addresses. If you want your database will be accessible from the internet, it should be public (vpc.public_subnet_ids). Otherwise, you can use private subnets (vpc.private_subnet_ids).
    vpcId String
    Vpc id.
    bastion BastionConfig
    Configure the bastion host for connecting the db.
    ipWhitelist List<String>
    List of whitelisted IP addresses. If not specified, it will be public 0.0.0.0/0
    skipFinalSnapshot Boolean
    Determines whether a final DB snapshot is created before the DB instance is deleted. Defaults to false
    databaseName string
    Name of the database.
    databaseType string
    Database type. mysql or postgresql
    masterUserName string
    Master user name of the db.
    subnetIds string[]
    List of subnet ip addresses. If you want your database will be accessible from the internet, it should be public (vpc.public_subnet_ids). Otherwise, you can use private subnets (vpc.private_subnet_ids).
    vpcId string
    Vpc id.
    bastion BastionConfig
    Configure the bastion host for connecting the db.
    ipWhitelist string[]
    List of whitelisted IP addresses. If not specified, it will be public 0.0.0.0/0
    skipFinalSnapshot boolean
    Determines whether a final DB snapshot is created before the DB instance is deleted. Defaults to false
    database_name str
    Name of the database.
    database_type str
    Database type. mysql or postgresql
    master_user_name str
    Master user name of the db.
    subnet_ids Sequence[str]
    List of subnet ip addresses. If you want your database will be accessible from the internet, it should be public (vpc.public_subnet_ids). Otherwise, you can use private subnets (vpc.private_subnet_ids).
    vpc_id str
    Vpc id.
    bastion BastionConfigArgs
    Configure the bastion host for connecting the db.
    ip_whitelist Sequence[str]
    List of whitelisted IP addresses. If not specified, it will be public 0.0.0.0/0
    skip_final_snapshot bool
    Determines whether a final DB snapshot is created before the DB instance is deleted. Defaults to false
    databaseName String
    Name of the database.
    databaseType String
    Database type. mysql or postgresql
    masterUserName String
    Master user name of the db.
    subnetIds List<String>
    List of subnet ip addresses. If you want your database will be accessible from the internet, it should be public (vpc.public_subnet_ids). Otherwise, you can use private subnets (vpc.private_subnet_ids).
    vpcId String
    Vpc id.
    bastion Property Map
    Configure the bastion host for connecting the db.
    ipWhitelist List<String>
    List of whitelisted IP addresses. If not specified, it will be public 0.0.0.0/0
    skipFinalSnapshot Boolean
    Determines whether a final DB snapshot is created before the DB instance is deleted. Defaults to false

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ServerlessDatabase resource produces the following output properties:

    Cluster_arn string
    ARN (Amazon Resource Name) of the RDS cluster.
    Database_name string
    Name of the database
    Host string
    Host address of DB server
    Port double
    Port number of DB
    Uri string
    Database URI for connection.
    User string
    Username of DB credentials.
    Bastion_ip string
    IP address of the bastion host. Exists only if bastion is enabled
    Bastion_private_key string
    Private key to connect bastion host over SSH. Exists only if bastion is enabled.
    Password string
    Password of DB credentials
    Cluster_arn string
    ARN (Amazon Resource Name) of the RDS cluster.
    Database_name string
    Name of the database
    Host string
    Host address of DB server
    Port float64
    Port number of DB
    Uri string
    Database URI for connection.
    User string
    Username of DB credentials.
    Bastion_ip string
    IP address of the bastion host. Exists only if bastion is enabled
    Bastion_private_key string
    Private key to connect bastion host over SSH. Exists only if bastion is enabled.
    Password string
    Password of DB credentials
    cluster_arn String
    ARN (Amazon Resource Name) of the RDS cluster.
    database_name String
    Name of the database
    host String
    Host address of DB server
    port Double
    Port number of DB
    uri String
    Database URI for connection.
    user String
    Username of DB credentials.
    bastion_ip String
    IP address of the bastion host. Exists only if bastion is enabled
    bastion_private_key String
    Private key to connect bastion host over SSH. Exists only if bastion is enabled.
    password String
    Password of DB credentials
    cluster_arn string
    ARN (Amazon Resource Name) of the RDS cluster.
    database_name string
    Name of the database
    host string
    Host address of DB server
    port number
    Port number of DB
    uri string
    Database URI for connection.
    user string
    Username of DB credentials.
    bastion_ip string
    IP address of the bastion host. Exists only if bastion is enabled
    bastion_private_key string
    Private key to connect bastion host over SSH. Exists only if bastion is enabled.
    password string
    Password of DB credentials
    cluster_arn str
    ARN (Amazon Resource Name) of the RDS cluster.
    database_name str
    Name of the database
    host str
    Host address of DB server
    port float
    Port number of DB
    uri str
    Database URI for connection.
    user str
    Username of DB credentials.
    bastion_ip str
    IP address of the bastion host. Exists only if bastion is enabled
    bastion_private_key str
    Private key to connect bastion host over SSH. Exists only if bastion is enabled.
    password str
    Password of DB credentials
    cluster_arn String
    ARN (Amazon Resource Name) of the RDS cluster.
    database_name String
    Name of the database
    host String
    Host address of DB server
    port Number
    Port number of DB
    uri String
    Database URI for connection.
    user String
    Username of DB credentials.
    bastion_ip String
    IP address of the bastion host. Exists only if bastion is enabled
    bastion_private_key String
    Private key to connect bastion host over SSH. Exists only if bastion is enabled.
    password String
    Password of DB credentials

    Supporting Types

    BastionConfig, BastionConfigArgs

    Enabled bool
    Enable data api. Defaults to false
    SubnetId string
    Public subnet id for the bastion host. You may useawsx.ec2.Vpc.public_subnet_ids[0]
    Enabled bool
    Enable data api. Defaults to false
    SubnetId string
    Public subnet id for the bastion host. You may useawsx.ec2.Vpc.public_subnet_ids[0]
    enabled Boolean
    Enable data api. Defaults to false
    subnetId String
    Public subnet id for the bastion host. You may useawsx.ec2.Vpc.public_subnet_ids[0]
    enabled boolean
    Enable data api. Defaults to false
    subnetId string
    Public subnet id for the bastion host. You may useawsx.ec2.Vpc.public_subnet_ids[0]
    enabled bool
    Enable data api. Defaults to false
    subnet_id str
    Public subnet id for the bastion host. You may useawsx.ec2.Vpc.public_subnet_ids[0]
    enabled Boolean
    Enable data api. Defaults to false
    subnetId String
    Public subnet id for the bastion host. You may useawsx.ec2.Vpc.public_subnet_ids[0]

    Package Details

    Repository
    nuage
    License
    Apache-2.0
    nuage logo
    nuage v0.1.1 published on Friday, Mar 17, 2023 by Nuage-Studio
    nuage-studio/pulumi-nuage