1. Packages
  2. AWS QuickStart Aurora Postgres
  3. API Docs
  4. Cluster
AWS QuickStart Aurora Postgres v0.0.3 published on Friday, Oct 15, 2021 by Pulumi

aws-quickstart-aurora-postgres.Cluster

Explore with Pulumi AI

aws-quickstart-aurora-postgres logo
AWS QuickStart Aurora Postgres v0.0.3 published on Friday, Oct 15, 2021 by Pulumi

    Create Cluster Resource

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

    Constructor syntax

    new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
    @overload
    def Cluster(resource_name: str,
                args: ClusterArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Cluster(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                db_name: Optional[str] = None,
                private_subnet_id1: Optional[str] = None,
                availability_zone_names: Optional[Sequence[str]] = None,
                db_parameter_group_family: Optional[str] = None,
                db_engine_version: Optional[str] = None,
                db_instance_class: Optional[str] = None,
                db_master_password: Optional[str] = None,
                db_master_username: Optional[str] = None,
                vpc_id: Optional[str] = None,
                private_subnet_id2: Optional[str] = None,
                db_backup_retention_period: Optional[int] = None,
                db_port: Optional[float] = None,
                db_security_group_id: Optional[str] = None,
                enable_event_subscription: Optional[bool] = None,
                db_encrypted_enabled: Optional[bool] = None,
                db_auto_minor_version_upgrade: Optional[bool] = None,
                sns_notification_email: Optional[str] = None,
                db_num_db_cluster_instances: Optional[int] = None)
    func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
    public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
    
    type: aws-quickstart-aurora-postgres:Cluster
    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 ClusterArgs
    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 ClusterArgs
    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 ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var clusterResource = new AwsQuickStartAuroraPostgres.Cluster("clusterResource", new()
    {
        DbName = "string",
        PrivateSubnetID1 = "string",
        AvailabilityZoneNames = new()
        {
            "string",
        },
        DbParameterGroupFamily = "string",
        DbEngineVersion = "string",
        DbInstanceClass = "string",
        DbMasterPassword = "string",
        DbMasterUsername = "string",
        VpcID = "string",
        PrivateSubnetID2 = "string",
        DbBackupRetentionPeriod = 0,
        DbPort = 0,
        DbSecurityGroupID = "string",
        EnableEventSubscription = false,
        DbEncryptedEnabled = false,
        DbAutoMinorVersionUpgrade = false,
        SnsNotificationEmail = "string",
        DbNumDbClusterInstances = 0,
    });
    
    example, err := awsquickstartaurorapostgres.NewCluster(ctx, "clusterResource", &awsquickstartaurorapostgres.ClusterArgs{
    	DbName:           "string",
    	PrivateSubnetID1: pulumi.String("string"),
    	AvailabilityZoneNames: []pulumi.String{
    		pulumi.String("string"),
    	},
    	DbParameterGroupFamily:    "string",
    	DbEngineVersion:           "string",
    	DbInstanceClass:           "string",
    	DbMasterPassword:          pulumi.String("string"),
    	DbMasterUsername:          "string",
    	VpcID:                     pulumi.String("string"),
    	PrivateSubnetID2:          pulumi.String("string"),
    	DbBackupRetentionPeriod:   0,
    	DbPort:                    0,
    	DbSecurityGroupID:         pulumi.String("string"),
    	EnableEventSubscription:   false,
    	DbEncryptedEnabled:        false,
    	DbAutoMinorVersionUpgrade: false,
    	SnsNotificationEmail:      "string",
    	DbNumDbClusterInstances:   0,
    })
    
    var clusterResource = new Cluster("clusterResource", ClusterArgs.builder()
        .dbName("string")
        .privateSubnetID1("string")
        .availabilityZoneNames("string")
        .dbParameterGroupFamily("string")
        .dbEngineVersion("string")
        .dbInstanceClass("string")
        .dbMasterPassword("string")
        .dbMasterUsername("string")
        .vpcID("string")
        .privateSubnetID2("string")
        .dbBackupRetentionPeriod(0)
        .dbPort(0)
        .dbSecurityGroupID("string")
        .enableEventSubscription(false)
        .dbEncryptedEnabled(false)
        .dbAutoMinorVersionUpgrade(false)
        .snsNotificationEmail("string")
        .dbNumDbClusterInstances(0)
        .build());
    
    cluster_resource = aws_quickstart_aurora_postgres.Cluster("clusterResource",
        db_name="string",
        private_subnet_id1="string",
        availability_zone_names=["string"],
        db_parameter_group_family="string",
        db_engine_version="string",
        db_instance_class="string",
        db_master_password="string",
        db_master_username="string",
        vpc_id="string",
        private_subnet_id2="string",
        db_backup_retention_period=0,
        db_port=0,
        db_security_group_id="string",
        enable_event_subscription=False,
        db_encrypted_enabled=False,
        db_auto_minor_version_upgrade=False,
        sns_notification_email="string",
        db_num_db_cluster_instances=0)
    
    const clusterResource = new aws_quickstart_aurora_postgres.Cluster("clusterResource", {
        dbName: "string",
        privateSubnetID1: "string",
        availabilityZoneNames: ["string"],
        dbParameterGroupFamily: "string",
        dbEngineVersion: "string",
        dbInstanceClass: "string",
        dbMasterPassword: "string",
        dbMasterUsername: "string",
        vpcID: "string",
        privateSubnetID2: "string",
        dbBackupRetentionPeriod: 0,
        dbPort: 0,
        dbSecurityGroupID: "string",
        enableEventSubscription: false,
        dbEncryptedEnabled: false,
        dbAutoMinorVersionUpgrade: false,
        snsNotificationEmail: "string",
        dbNumDbClusterInstances: 0,
    });
    
    type: aws-quickstart-aurora-postgres:Cluster
    properties:
        availabilityZoneNames:
            - string
        dbAutoMinorVersionUpgrade: false
        dbBackupRetentionPeriod: 0
        dbEncryptedEnabled: false
        dbEngineVersion: string
        dbInstanceClass: string
        dbMasterPassword: string
        dbMasterUsername: string
        dbName: string
        dbNumDbClusterInstances: 0
        dbParameterGroupFamily: string
        dbPort: 0
        dbSecurityGroupID: string
        enableEventSubscription: false
        privateSubnetID1: string
        privateSubnetID2: string
        snsNotificationEmail: string
        vpcID: string
    

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

    AvailabilityZoneNames List<string>
    List of Availability Zone names to use to create the DB Cluster.
    DbEngineVersion string
    The version of the database engine.
    DbInstanceClass string
    The DB (compute and memory capacity) class for the database instances.
    DbMasterPassword string
    The password for the database administrator account (8-64 character string)
    DbMasterUsername string
    The user name for the database administrator account. This is an alphanumeric string of 1-16 characters. The user name must start with an uppercase or lowercase letter (A-Z, a-z).
    DbName string
    The name of the Aurora DB to provision. This is an alphanumeric string of 5-64 characters.
    DbParameterGroupFamily string
    The family of the DB parameter group (e.g. aurora-postgresql11).
    PrivateSubnetID1 string
    The ID of the private subnet in Availability Zone 1 in your existing VPC (e.g., subnet-a0246dcd).
    PrivateSubnetID2 string
    The ID of the private subnet in Availability Zone 2 in your existing VPC (e.g., subnet-b58c3d67).
    VpcID string
    The ID of your existing VPC (e.g., vpc-0343606e) where you want to deploy the Aurora database.
    DbAutoMinorVersionUpgrade bool
    Set this parameter to true if you want to enable your DB instances to receive minor DB engine version upgrades automatically when upgrades become available.
    DbBackupRetentionPeriod int
    The number of days to retain automatic database snapshots. To disable automatic backups, set this parameter to 0. Default is 35 days
    DbEncryptedEnabled bool
    Set this parameter to false if you don’t want to encrypt the database at rest. Defaults to true.
    DbNumDbClusterInstances int
    The number of db instances to launch as part of the cluster. Defaults to 1.
    DbPort double
    The port that you want to access the database through. The DB instance will listen on this port for connections. This value must be in the range 1115-65535. Default is 5432
    DbSecurityGroupID string
    The ID of the custom security group you want to use in your existing VPC (e.g., sg-7f16e910).
    EnableEventSubscription bool
    Set this parameter to false if you want to disable Amazon Aurora Cluster and Instance level event subscriptions. You might want to disable it if you are testing or running continuous integration (CI) processes.
    SnsNotificationEmail string
    The email that is used to configure an SNS topic for sending CloudWatch alarms and Amazon RDS event notifications. This must be a valid email address. Required if enableEventSubscription is true.
    AvailabilityZoneNames []string
    List of Availability Zone names to use to create the DB Cluster.
    DbEngineVersion string
    The version of the database engine.
    DbInstanceClass string
    The DB (compute and memory capacity) class for the database instances.
    DbMasterPassword string
    The password for the database administrator account (8-64 character string)
    DbMasterUsername string
    The user name for the database administrator account. This is an alphanumeric string of 1-16 characters. The user name must start with an uppercase or lowercase letter (A-Z, a-z).
    DbName string
    The name of the Aurora DB to provision. This is an alphanumeric string of 5-64 characters.
    DbParameterGroupFamily string
    The family of the DB parameter group (e.g. aurora-postgresql11).
    PrivateSubnetID1 string
    The ID of the private subnet in Availability Zone 1 in your existing VPC (e.g., subnet-a0246dcd).
    PrivateSubnetID2 string
    The ID of the private subnet in Availability Zone 2 in your existing VPC (e.g., subnet-b58c3d67).
    VpcID string
    The ID of your existing VPC (e.g., vpc-0343606e) where you want to deploy the Aurora database.
    DbAutoMinorVersionUpgrade bool
    Set this parameter to true if you want to enable your DB instances to receive minor DB engine version upgrades automatically when upgrades become available.
    DbBackupRetentionPeriod int
    The number of days to retain automatic database snapshots. To disable automatic backups, set this parameter to 0. Default is 35 days
    DbEncryptedEnabled bool
    Set this parameter to false if you don’t want to encrypt the database at rest. Defaults to true.
    DbNumDbClusterInstances int
    The number of db instances to launch as part of the cluster. Defaults to 1.
    DbPort float64
    The port that you want to access the database through. The DB instance will listen on this port for connections. This value must be in the range 1115-65535. Default is 5432
    DbSecurityGroupID string
    The ID of the custom security group you want to use in your existing VPC (e.g., sg-7f16e910).
    EnableEventSubscription bool
    Set this parameter to false if you want to disable Amazon Aurora Cluster and Instance level event subscriptions. You might want to disable it if you are testing or running continuous integration (CI) processes.
    SnsNotificationEmail string
    The email that is used to configure an SNS topic for sending CloudWatch alarms and Amazon RDS event notifications. This must be a valid email address. Required if enableEventSubscription is true.
    availabilityZoneNames List<String>
    List of Availability Zone names to use to create the DB Cluster.
    dbEngineVersion String
    The version of the database engine.
    dbInstanceClass String
    The DB (compute and memory capacity) class for the database instances.
    dbMasterPassword String
    The password for the database administrator account (8-64 character string)
    dbMasterUsername String
    The user name for the database administrator account. This is an alphanumeric string of 1-16 characters. The user name must start with an uppercase or lowercase letter (A-Z, a-z).
    dbName String
    The name of the Aurora DB to provision. This is an alphanumeric string of 5-64 characters.
    dbParameterGroupFamily String
    The family of the DB parameter group (e.g. aurora-postgresql11).
    privateSubnetID1 String
    The ID of the private subnet in Availability Zone 1 in your existing VPC (e.g., subnet-a0246dcd).
    privateSubnetID2 String
    The ID of the private subnet in Availability Zone 2 in your existing VPC (e.g., subnet-b58c3d67).
    vpcID String
    The ID of your existing VPC (e.g., vpc-0343606e) where you want to deploy the Aurora database.
    dbAutoMinorVersionUpgrade Boolean
    Set this parameter to true if you want to enable your DB instances to receive minor DB engine version upgrades automatically when upgrades become available.
    dbBackupRetentionPeriod Integer
    The number of days to retain automatic database snapshots. To disable automatic backups, set this parameter to 0. Default is 35 days
    dbEncryptedEnabled Boolean
    Set this parameter to false if you don’t want to encrypt the database at rest. Defaults to true.
    dbNumDbClusterInstances Integer
    The number of db instances to launch as part of the cluster. Defaults to 1.
    dbPort Double
    The port that you want to access the database through. The DB instance will listen on this port for connections. This value must be in the range 1115-65535. Default is 5432
    dbSecurityGroupID String
    The ID of the custom security group you want to use in your existing VPC (e.g., sg-7f16e910).
    enableEventSubscription Boolean
    Set this parameter to false if you want to disable Amazon Aurora Cluster and Instance level event subscriptions. You might want to disable it if you are testing or running continuous integration (CI) processes.
    snsNotificationEmail String
    The email that is used to configure an SNS topic for sending CloudWatch alarms and Amazon RDS event notifications. This must be a valid email address. Required if enableEventSubscription is true.
    availabilityZoneNames string[]
    List of Availability Zone names to use to create the DB Cluster.
    dbEngineVersion string
    The version of the database engine.
    dbInstanceClass string
    The DB (compute and memory capacity) class for the database instances.
    dbMasterPassword string
    The password for the database administrator account (8-64 character string)
    dbMasterUsername string
    The user name for the database administrator account. This is an alphanumeric string of 1-16 characters. The user name must start with an uppercase or lowercase letter (A-Z, a-z).
    dbName string
    The name of the Aurora DB to provision. This is an alphanumeric string of 5-64 characters.
    dbParameterGroupFamily string
    The family of the DB parameter group (e.g. aurora-postgresql11).
    privateSubnetID1 string
    The ID of the private subnet in Availability Zone 1 in your existing VPC (e.g., subnet-a0246dcd).
    privateSubnetID2 string
    The ID of the private subnet in Availability Zone 2 in your existing VPC (e.g., subnet-b58c3d67).
    vpcID string
    The ID of your existing VPC (e.g., vpc-0343606e) where you want to deploy the Aurora database.
    dbAutoMinorVersionUpgrade boolean
    Set this parameter to true if you want to enable your DB instances to receive minor DB engine version upgrades automatically when upgrades become available.
    dbBackupRetentionPeriod number
    The number of days to retain automatic database snapshots. To disable automatic backups, set this parameter to 0. Default is 35 days
    dbEncryptedEnabled boolean
    Set this parameter to false if you don’t want to encrypt the database at rest. Defaults to true.
    dbNumDbClusterInstances number
    The number of db instances to launch as part of the cluster. Defaults to 1.
    dbPort number
    The port that you want to access the database through. The DB instance will listen on this port for connections. This value must be in the range 1115-65535. Default is 5432
    dbSecurityGroupID string
    The ID of the custom security group you want to use in your existing VPC (e.g., sg-7f16e910).
    enableEventSubscription boolean
    Set this parameter to false if you want to disable Amazon Aurora Cluster and Instance level event subscriptions. You might want to disable it if you are testing or running continuous integration (CI) processes.
    snsNotificationEmail string
    The email that is used to configure an SNS topic for sending CloudWatch alarms and Amazon RDS event notifications. This must be a valid email address. Required if enableEventSubscription is true.
    availability_zone_names Sequence[str]
    List of Availability Zone names to use to create the DB Cluster.
    db_engine_version str
    The version of the database engine.
    db_instance_class str
    The DB (compute and memory capacity) class for the database instances.
    db_master_password str
    The password for the database administrator account (8-64 character string)
    db_master_username str
    The user name for the database administrator account. This is an alphanumeric string of 1-16 characters. The user name must start with an uppercase or lowercase letter (A-Z, a-z).
    db_name str
    The name of the Aurora DB to provision. This is an alphanumeric string of 5-64 characters.
    db_parameter_group_family str
    The family of the DB parameter group (e.g. aurora-postgresql11).
    private_subnet_id1 str
    The ID of the private subnet in Availability Zone 1 in your existing VPC (e.g., subnet-a0246dcd).
    private_subnet_id2 str
    The ID of the private subnet in Availability Zone 2 in your existing VPC (e.g., subnet-b58c3d67).
    vpc_id str
    The ID of your existing VPC (e.g., vpc-0343606e) where you want to deploy the Aurora database.
    db_auto_minor_version_upgrade bool
    Set this parameter to true if you want to enable your DB instances to receive minor DB engine version upgrades automatically when upgrades become available.
    db_backup_retention_period int
    The number of days to retain automatic database snapshots. To disable automatic backups, set this parameter to 0. Default is 35 days
    db_encrypted_enabled bool
    Set this parameter to false if you don’t want to encrypt the database at rest. Defaults to true.
    db_num_db_cluster_instances int
    The number of db instances to launch as part of the cluster. Defaults to 1.
    db_port float
    The port that you want to access the database through. The DB instance will listen on this port for connections. This value must be in the range 1115-65535. Default is 5432
    db_security_group_id str
    The ID of the custom security group you want to use in your existing VPC (e.g., sg-7f16e910).
    enable_event_subscription bool
    Set this parameter to false if you want to disable Amazon Aurora Cluster and Instance level event subscriptions. You might want to disable it if you are testing or running continuous integration (CI) processes.
    sns_notification_email str
    The email that is used to configure an SNS topic for sending CloudWatch alarms and Amazon RDS event notifications. This must be a valid email address. Required if enableEventSubscription is true.
    availabilityZoneNames List<String>
    List of Availability Zone names to use to create the DB Cluster.
    dbEngineVersion String
    The version of the database engine.
    dbInstanceClass String
    The DB (compute and memory capacity) class for the database instances.
    dbMasterPassword String
    The password for the database administrator account (8-64 character string)
    dbMasterUsername String
    The user name for the database administrator account. This is an alphanumeric string of 1-16 characters. The user name must start with an uppercase or lowercase letter (A-Z, a-z).
    dbName String
    The name of the Aurora DB to provision. This is an alphanumeric string of 5-64 characters.
    dbParameterGroupFamily String
    The family of the DB parameter group (e.g. aurora-postgresql11).
    privateSubnetID1 String
    The ID of the private subnet in Availability Zone 1 in your existing VPC (e.g., subnet-a0246dcd).
    privateSubnetID2 String
    The ID of the private subnet in Availability Zone 2 in your existing VPC (e.g., subnet-b58c3d67).
    vpcID String
    The ID of your existing VPC (e.g., vpc-0343606e) where you want to deploy the Aurora database.
    dbAutoMinorVersionUpgrade Boolean
    Set this parameter to true if you want to enable your DB instances to receive minor DB engine version upgrades automatically when upgrades become available.
    dbBackupRetentionPeriod Number
    The number of days to retain automatic database snapshots. To disable automatic backups, set this parameter to 0. Default is 35 days
    dbEncryptedEnabled Boolean
    Set this parameter to false if you don’t want to encrypt the database at rest. Defaults to true.
    dbNumDbClusterInstances Number
    The number of db instances to launch as part of the cluster. Defaults to 1.
    dbPort Number
    The port that you want to access the database through. The DB instance will listen on this port for connections. This value must be in the range 1115-65535. Default is 5432
    dbSecurityGroupID String
    The ID of the custom security group you want to use in your existing VPC (e.g., sg-7f16e910).
    enableEventSubscription Boolean
    Set this parameter to false if you want to disable Amazon Aurora Cluster and Instance level event subscriptions. You might want to disable it if you are testing or running continuous integration (CI) processes.
    snsNotificationEmail String
    The email that is used to configure an SNS topic for sending CloudWatch alarms and Amazon RDS event notifications. This must be a valid email address. Required if enableEventSubscription is true.

    Outputs

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

    Package Details

    Repository
    AWS QuickStart Aurora PostgreSQL
    License
    aws-quickstart-aurora-postgres logo
    AWS QuickStart Aurora Postgres v0.0.3 published on Friday, Oct 15, 2021 by Pulumi