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 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.
Constructor 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:
- Availability
Zone List<string>Names - List of Availability Zone names to use to create the DB Cluster.
- Db
Engine stringVersion - The version of the database engine.
- Db
Instance stringClass - The DB (compute and memory capacity) class for the database instances.
- Db
Master stringPassword - The password for the database administrator account (8-64 character string)
- Db
Master stringUsername - 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 string - The name of the Aurora DB to provision. This is an alphanumeric string of 5-64 characters.
- Db
Parameter stringGroup Family - The family of the DB parameter group (e.g. aurora-postgresql11).
- Private
Subnet stringID1 - The ID of the private subnet in Availability Zone 1 in your existing VPC (e.g., subnet-a0246dcd).
- Private
Subnet stringID2 - The ID of the private subnet in Availability Zone 2 in your existing VPC (e.g., subnet-b58c3d67).
- Vpc
ID string - The ID of your existing VPC (e.g., vpc-0343606e) where you want to deploy the Aurora database.
- Db
Auto boolMinor Version Upgrade - 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 intRetention Period - The number of days to retain automatic database snapshots. To disable automatic backups, set this parameter to 0. Default is 35 days
- Db
Encrypted boolEnabled - Set this parameter to false if you don’t want to encrypt the
database at rest. Defaults to
true
. - Db
Num intDb Cluster Instances - The number of db instances to launch as part of the cluster. Defaults to 1.
- Db
Port 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
- Db
Security stringGroup ID - The ID of the custom security group you want to use in your existing VPC (e.g., sg-7f16e910).
- Enable
Event boolSubscription - 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 stringEmail - 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 []stringNames - List of Availability Zone names to use to create the DB Cluster.
- Db
Engine stringVersion - The version of the database engine.
- Db
Instance stringClass - The DB (compute and memory capacity) class for the database instances.
- Db
Master stringPassword - The password for the database administrator account (8-64 character string)
- Db
Master stringUsername - 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 string - The name of the Aurora DB to provision. This is an alphanumeric string of 5-64 characters.
- Db
Parameter stringGroup Family - The family of the DB parameter group (e.g. aurora-postgresql11).
- Private
Subnet stringID1 - The ID of the private subnet in Availability Zone 1 in your existing VPC (e.g., subnet-a0246dcd).
- Private
Subnet stringID2 - The ID of the private subnet in Availability Zone 2 in your existing VPC (e.g., subnet-b58c3d67).
- Vpc
ID string - The ID of your existing VPC (e.g., vpc-0343606e) where you want to deploy the Aurora database.
- Db
Auto boolMinor Version Upgrade - 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 intRetention Period - The number of days to retain automatic database snapshots. To disable automatic backups, set this parameter to 0. Default is 35 days
- Db
Encrypted boolEnabled - Set this parameter to false if you don’t want to encrypt the
database at rest. Defaults to
true
. - Db
Num intDb Cluster Instances - The number of db instances to launch as part of the cluster. Defaults to 1.
- Db
Port 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
- Db
Security stringGroup ID - The ID of the custom security group you want to use in your existing VPC (e.g., sg-7f16e910).
- Enable
Event boolSubscription - 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 stringEmail - 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 List<String>Names - List of Availability Zone names to use to create the DB Cluster.
- db
Engine StringVersion - The version of the database engine.
- db
Instance StringClass - The DB (compute and memory capacity) class for the database instances.
- db
Master StringPassword - The password for the database administrator account (8-64 character string)
- db
Master StringUsername - 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 String - The name of the Aurora DB to provision. This is an alphanumeric string of 5-64 characters.
- db
Parameter StringGroup Family - The family of the DB parameter group (e.g. aurora-postgresql11).
- private
Subnet StringID1 - The ID of the private subnet in Availability Zone 1 in your existing VPC (e.g., subnet-a0246dcd).
- private
Subnet StringID2 - The ID of the private subnet in Availability Zone 2 in your existing VPC (e.g., subnet-b58c3d67).
- vpc
ID String - The ID of your existing VPC (e.g., vpc-0343606e) where you want to deploy the Aurora database.
- db
Auto BooleanMinor Version Upgrade - 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 IntegerRetention Period - The number of days to retain automatic database snapshots. To disable automatic backups, set this parameter to 0. Default is 35 days
- db
Encrypted BooleanEnabled - Set this parameter to false if you don’t want to encrypt the
database at rest. Defaults to
true
. - db
Num IntegerDb Cluster Instances - The number of db instances to launch as part of the cluster. Defaults to 1.
- db
Port 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
- db
Security StringGroup ID - The ID of the custom security group you want to use in your existing VPC (e.g., sg-7f16e910).
- enable
Event BooleanSubscription - 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 StringEmail - 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 string[]Names - List of Availability Zone names to use to create the DB Cluster.
- db
Engine stringVersion - The version of the database engine.
- db
Instance stringClass - The DB (compute and memory capacity) class for the database instances.
- db
Master stringPassword - The password for the database administrator account (8-64 character string)
- db
Master stringUsername - 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 string - The name of the Aurora DB to provision. This is an alphanumeric string of 5-64 characters.
- db
Parameter stringGroup Family - The family of the DB parameter group (e.g. aurora-postgresql11).
- private
Subnet stringID1 - The ID of the private subnet in Availability Zone 1 in your existing VPC (e.g., subnet-a0246dcd).
- private
Subnet stringID2 - The ID of the private subnet in Availability Zone 2 in your existing VPC (e.g., subnet-b58c3d67).
- vpc
ID string - The ID of your existing VPC (e.g., vpc-0343606e) where you want to deploy the Aurora database.
- db
Auto booleanMinor Version Upgrade - 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 numberRetention Period - The number of days to retain automatic database snapshots. To disable automatic backups, set this parameter to 0. Default is 35 days
- db
Encrypted booleanEnabled - Set this parameter to false if you don’t want to encrypt the
database at rest. Defaults to
true
. - db
Num numberDb Cluster Instances - The number of db instances to launch as part of the cluster. Defaults to 1.
- db
Port 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
- db
Security stringGroup ID - The ID of the custom security group you want to use in your existing VPC (e.g., sg-7f16e910).
- enable
Event booleanSubscription - 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 stringEmail - 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_ Sequence[str]names - List of Availability Zone names to use to create the DB Cluster.
- db_
engine_ strversion - The version of the database engine.
- db_
instance_ strclass - The DB (compute and memory capacity) class for the database instances.
- db_
master_ strpassword - The password for the database administrator account (8-64 character string)
- db_
master_ strusername - 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_ strgroup_ family - The family of the DB parameter group (e.g. aurora-postgresql11).
- private_
subnet_ strid1 - The ID of the private subnet in Availability Zone 1 in your existing VPC (e.g., subnet-a0246dcd).
- private_
subnet_ strid2 - 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_ boolminor_ version_ upgrade - 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_ intretention_ period - The number of days to retain automatic database snapshots. To disable automatic backups, set this parameter to 0. Default is 35 days
- db_
encrypted_ boolenabled - Set this parameter to false if you don’t want to encrypt the
database at rest. Defaults to
true
. - db_
num_ intdb_ cluster_ instances - 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_ strgroup_ id - The ID of the custom security group you want to use in your existing VPC (e.g., sg-7f16e910).
- enable_
event_ boolsubscription - 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_ stremail - 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 List<String>Names - List of Availability Zone names to use to create the DB Cluster.
- db
Engine StringVersion - The version of the database engine.
- db
Instance StringClass - The DB (compute and memory capacity) class for the database instances.
- db
Master StringPassword - The password for the database administrator account (8-64 character string)
- db
Master StringUsername - 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 String - The name of the Aurora DB to provision. This is an alphanumeric string of 5-64 characters.
- db
Parameter StringGroup Family - The family of the DB parameter group (e.g. aurora-postgresql11).
- private
Subnet StringID1 - The ID of the private subnet in Availability Zone 1 in your existing VPC (e.g., subnet-a0246dcd).
- private
Subnet StringID2 - The ID of the private subnet in Availability Zone 2 in your existing VPC (e.g., subnet-b58c3d67).
- vpc
ID String - The ID of your existing VPC (e.g., vpc-0343606e) where you want to deploy the Aurora database.
- db
Auto BooleanMinor Version Upgrade - 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 NumberRetention Period - The number of days to retain automatic database snapshots. To disable automatic backups, set this parameter to 0. Default is 35 days
- db
Encrypted BooleanEnabled - Set this parameter to false if you don’t want to encrypt the
database at rest. Defaults to
true
. - db
Num NumberDb Cluster Instances - The number of db instances to launch as part of the cluster. Defaults to 1.
- db
Port 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
- db
Security StringGroup ID - The ID of the custom security group you want to use in your existing VPC (e.g., sg-7f16e910).
- enable
Event BooleanSubscription - 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 StringEmail - 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 v0.0.3 published on Friday, Oct 15, 2021 by Pulumi