PHP Class Scalr\Service\Aws\Rds\DataType\CreateDBClusterRequestData

Author: N.V.
Inheritance: extends Scalr\Service\Aws\Rds\AbstractRdsDataType
Datei anzeigen Open project: scalr/scalr Class Usage Examples

Public Properties

Property Type Description
$backupRetentionPeriod integer Constraints: Must be a value from 0 to 8 Cannot be set to 0 if the DB Instance is a master instance with read replicas Default: 1
$characterSetName string For supported engines, indicates that the DB Cluster should be associated with the specified CharacterSet.
$dBClusterIdentifier string This is the unique key that identifies a DB Cluster
$dBClusterParameterGroupName string Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
$dBSubnetGroupName string If there is no DB Subnet Group, then it is a non-VPC DB instance.
$databaseName string Constraints: Must contain 1 to 64 alphanumeric characters Cannot be a word reserved by the specified database engine
$engine string Provides the name of the database engine to be used for this DB Cluster.
$engineVersion string MySQL Example: 5.1.42
$kmsKeyId string The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key. If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
$masterUserPassword string Constraints: Must contain from 8 to 41 alphanumeric characters.
$masterUsername string Constraints: Must be 1 to 16 alphanumeric characters. First character must be a letter. Cannot be a reserved word for the chosen database engine.
$optionGroupName string Indicates that the DB Cluster should be associated with the specified option group.
$port integer Default: 3306 Valid Values: 1150-65535
$preferredBackupWindow string Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned. US-East (Northern Virginia) Region: 03:00-11:00 UTC US-West (Northern California) Region: 06:00-14:00 UTC EU (Ireland) Region: 22:00-06:00 UTC Asia Pacific (Singapore) Region: 14:00-22:00 UTC Asia Pacific (Tokyo) Region: 17:00-03:00 UTC Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
$preferredMaintenanceWindow string Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. The following list shows the time blocks for each region from which the default maintenance windows are assigned. US-East (Northern Virginia) Region: 03:00-11:00 UTC US-West (Northern California) Region: 06:00-14:00 UTC EU (Ireland) Region: 22:00-06:00 UTC Asia Pacific (Singapore) Region: 14:00-22:00 UTC Asia Pacific (Tokyo) Region: 17:00-03:00 UTC Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window.
$storageEncrypted boolean Specifies whether the DB cluster is encrypted.

Protected Properties

Property Type Description
$_properties array List of the public properties which is managed by magic getter and setters internally.

Public Methods

Method Description
__construct ( string $dBClusterIdentifier, string $engine, string $masterUsername, string $masterUserPassword ) Constructor
setAvailabilityZones ( ListDataType | array | string $availabilityZones = null ) : Scalr\Service\Aws\Rds\DataType\CreateDBInstanceRequestData Sets AvailabilityZones list
setTags ( Scalr\Service\Aws\Rds\DataType\TagsList | array | string $tags = null ) : Scalr\Service\Aws\Rds\DataType\CreateDBInstanceRequestData Sets Tags list
setVpcSecurityGroupIds ( ListDataType | array | string $vpcSecurityGroupIds = null ) : Scalr\Service\Aws\Rds\DataType\CreateDBInstanceRequestData Sets VpcSecurityGroupIds list

Method Details

__construct() public method

Constructor
public __construct ( string $dBClusterIdentifier, string $engine, string $masterUsername, string $masterUserPassword )
$dBClusterIdentifier string A user-supplied cluster identifier
$engine string The name of the database engine to be used for this DB Cluster
$masterUsername string The master username for database instances in this cluster
$masterUserPassword string The password form database instances in this cluster

setAvailabilityZones() public method

Sets AvailabilityZones list
public setAvailabilityZones ( ListDataType | array | string $availabilityZones = null ) : Scalr\Service\Aws\Rds\DataType\CreateDBInstanceRequestData
$availabilityZones Scalr\Service\Aws\DataType\ListDataType | array | string A list of Availability Zones that instances in the DB Cluster is located in.
return Scalr\Service\Aws\Rds\DataType\CreateDBInstanceRequestData

setTags() public method

Sets Tags list
public setTags ( Scalr\Service\Aws\Rds\DataType\TagsList | array | string $tags = null ) : Scalr\Service\Aws\Rds\DataType\CreateDBInstanceRequestData
$tags Scalr\Service\Aws\Rds\DataType\TagsList | array | string A list of tags to associate with this DB Cluster.
return Scalr\Service\Aws\Rds\DataType\CreateDBInstanceRequestData

setVpcSecurityGroupIds() public method

Sets VpcSecurityGroupIds list
public setVpcSecurityGroupIds ( ListDataType | array | string $vpcSecurityGroupIds = null ) : Scalr\Service\Aws\Rds\DataType\CreateDBInstanceRequestData
$vpcSecurityGroupIds Scalr\Service\Aws\DataType\ListDataType | array | string A list of EC2 VPC Security Groups to associate with this DB Cluster.
return Scalr\Service\Aws\Rds\DataType\CreateDBInstanceRequestData

Property Details

$_properties protected_oe property

List of the public properties which is managed by magic getter and setters internally.
protected array $_properties
return array

$backupRetentionPeriod public_oe property

Constraints: Must be a value from 0 to 8 Cannot be set to 0 if the DB Instance is a master instance with read replicas Default: 1
public int $backupRetentionPeriod
return integer

$characterSetName public_oe property

For supported engines, indicates that the DB Cluster should be associated with the specified CharacterSet.
public string $characterSetName
return string

$dBClusterIdentifier public_oe property

This is the unique key that identifies a DB Cluster
public string $dBClusterIdentifier
return string

$dBClusterParameterGroupName public_oe property

Constraints: Must be 1 to 255 alphanumeric characters First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens
public string $dBClusterParameterGroupName
return string

$dBSubnetGroupName public_oe property

If there is no DB Subnet Group, then it is a non-VPC DB instance.
public string $dBSubnetGroupName
return string

$databaseName public_oe property

Constraints: Must contain 1 to 64 alphanumeric characters Cannot be a word reserved by the specified database engine
public string $databaseName
return string

$engine public_oe property

Provides the name of the database engine to be used for this DB Cluster.
public string $engine
return string

$engineVersion public_oe property

MySQL Example: 5.1.42
public string $engineVersion
return string

$kmsKeyId public_oe property

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key. If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.
public string $kmsKeyId
return string

$masterUserPassword public_oe property

Constraints: Must contain from 8 to 41 alphanumeric characters.
public string $masterUserPassword
return string

$masterUsername public_oe property

Constraints: Must be 1 to 16 alphanumeric characters. First character must be a letter. Cannot be a reserved word for the chosen database engine.
public string $masterUsername
return string

$optionGroupName public_oe property

Indicates that the DB Cluster should be associated with the specified option group.
public string $optionGroupName
return string

$port public_oe property

Default: 3306 Valid Values: 1150-65535
public int $port
return integer

$preferredBackupWindow public_oe property

Default: A 30-minute window selected at random from an 8-hour block of time per region. The following list shows the time blocks for each region from which the default backup windows are assigned. US-East (Northern Virginia) Region: 03:00-11:00 UTC US-West (Northern California) Region: 06:00-14:00 UTC EU (Ireland) Region: 22:00-06:00 UTC Asia Pacific (Singapore) Region: 14:00-22:00 UTC Asia Pacific (Tokyo) Region: 17:00-03:00 UTC Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.
public string $preferredBackupWindow
return string

$preferredMaintenanceWindow public_oe property

Format: ddd:hh24:mi-ddd:hh24:mi Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. The following list shows the time blocks for each region from which the default maintenance windows are assigned. US-East (Northern Virginia) Region: 03:00-11:00 UTC US-West (Northern California) Region: 06:00-14:00 UTC EU (Ireland) Region: 22:00-06:00 UTC Asia Pacific (Singapore) Region: 14:00-22:00 UTC Asia Pacific (Tokyo) Region: 17:00-03:00 UTC Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window.
public string $preferredMaintenanceWindow
return string

$storageEncrypted public_oe property

Specifies whether the DB cluster is encrypted.
public bool $storageEncrypted
return boolean