Important: The Amazon Aurora MySQL-Compatible Edition service is in beta and is intended for evaluation and test purposes only. Do not use this service in a production environment.

This topic provides reference information about the Amazon Aurora MySQL-Compatible Edition (csb-aws-aurora-mysql) service. It describes the plans, configuration parameters, and binding credentials.

Plan Configuration Parameters

When configuring Cloud Service Broker for AWS you can add additional plans. For how to configure plans, see Configure Services with Cloud Service Broker for AWS.

The following table lists parameters that can only be configured for additional plans:

Parameter Name Values Default Required
name The plan name. n/a Yes
id A unique GUID. n/a Yes
description Description of the new plan. n/a Yes
display_name Name to use when displaying the plan in Marketplace. n/a No
free When false, service instances of this service plan have a cost. true No
bindable Specifies whether service instances of the service plan can bind to applications. true No
plan_updateable Whether the plan supports upgrading, downgrading, or sidegrading to another version. true No

You can also add any of the parameters listed in the Configuration Parameters section to your plan.

Note: If you set a parameter at plan level, developers cannot change the value when creating or updating service instances.

Configuration Parameters

You can provision a service by running:

cf create-service csb-aws-aurora-mysql PLAN-NAME SERVICE-INSTANCE-NAME -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}

You can update the configuration parameters for a service instance by running:

cf update-service SERVICE-INSTANCE-NAME -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'

The following table lists the parameters that you can configure, by using the -c flag, when provisioning or updating a csb-aws-aurora-mysql service. The Operation column displays whether a parameter is supported for both provision and update, or for provision only:

Parameter Name Type Description Default Operation
instance_name String The name of the AWS instance to create. csb-auroramy-INSTANCE-ID provision
db_name String The name of the database. csbdb provision
cluster_instances Integer The number of Aurora instances in the Aurora cluster. 3 provision and update
region String The AWS region to deploy the service in. For more information about available regions, see the AWS documentation. us-west-2 provision
serverless_min_capacity Number The minimum capacity for the cluster. Must be less than or equal to serverless_max_capacity. Valid capacity values are in a range of 0.5 up to 128, in steps of 0.5. null provision and update
serverless_max_capacity Number The maximum capacity for the cluster. Must be greater than or equal to serverless_min_capacity. Valid capacity values are in a range of 0.5 up to 128, in steps of 0.5. null provision and update
engine_version String The Aurora engine version, e.g. "8.0.mysql_aurora.3.02.0". Not all features are supported by all versions. Refer to the AWS documentation for more details.. null which results in the AWS default provision and update
rds_subnet_group String The name of the subnet to attach the database instance to. None provision
rds_vpc_security_group_ids Comma-separated String Security group IDs to assign to the database instance. None provision
allow_major_version_upgrade Boolean Indicates that major version upgrades are allowed. Changing this parameter does not cause an outage and the change is asynchronously applied as soon as possible. true provision and update
auto_minor_version_upgrade Boolean Indicates that minor engine upgrades are applied automatically to the database instance during the maintenance window. true provision and update
deletion_protection Boolean Whether deletion protection is enabled. You cannot delete the database cluster when this value is set, but you can delete database instances within the cluster. For more information about deleting Aurora database cluster and database instances, see the AWS documentation. For more information about storage reliability, see the AWS documentation.

Note: If the protection is active and a deprovision operation is performed, all instances associated with the cluster are erased. This leaves the system without computing capacity, and the service will stop. The data remains safe because it is associated with the virtual volume associated with the cluster. To recover the computing capacity after an accidental deprovision operation, set the number of instances that you want for the cluster through the property cluster_instances.

false provision and update
monitoring_interval Integer The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the database instance. To stop collecting Enhanced Monitoring metrics, enter 0. Valid values: 0, 1, 5, 10, 15, 30, 60. A monitoring_role_arn value is required if you enter a monitoring_interval value other than 0. 0 provision and update
monitoring_role_arn Integer Enhanced Monitoring requires permission to act on your behalf to send OS metric information to CloudWatch Logs. This property represents the Amazon Resource Names (ARN) for the Identity and Access Management (IAM) role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs. ""
performance_insights_enabled Boolean Specifies whether Performance Insights are enabled. Performance Insights expand on existing Amazon RDS monitoring features to illustrate your database performance and help you analyze it. From the Performance Insights dashboard you can visualize the database load on your Amazon RDS database instance load and filter the load by wait types, SQL statements, hosts, or users. false provision and update
performance_insights_kms_key_id String The ARN for the KMS key to encrypt Performance Insights data. When specifying performance_insights_kms_key_id, set performance_insights_enabled as true. After the KMS key is set, it can never be changed. "" provision and update
performance_insights_retention_period Integer The number of days for which to retain Performance Insights data.

The value must be 7, NUMBER-OF-MONTHS * 31 (where NUMBER-OF-MONTHS is 1-23), or 731.
For example, the following values are valid: 93 (because it's 3 months * 31), 341 (because it's 11 months * 31), 589 (because it's 19 months * 31), and 731.

If you specify an invalid retention period, such as 94, RDS issues an error.
7 provision and update
db_cluster_parameter_group_name String The Aurora MySQL database cluster parameter group name for the service. "" provision and update
enable_audit_logging Boolean If true, it enables the audit cloud_watch_log_export on the database cluster instances. It requires setting db_cluster_parameter_group_name with a pre-created database cluster parameter group that fulfils requirements for audit log exports. For configuration options, see the AWS documentation. false provision and update
cloudwatch_log_group_retention_in_days Integer If provided, it sets the retention days for the log group that contains the cluster audit logs. It is used in conjunction with enable_audit_logging. 30 provision and update
cloudwatch_log_group_kms_key_id String If provided, it sets the KSM key to use for encrypting the CloudWatch log group that is created for the cluster audit logs. It is used in conjunction with enable_audit_logging. "" provision and update
aws_access_key_id String The AWS Access Key to use for an instance. The value the operator entered for AWS Access Key in Ops Manager. provision and update
aws_secret_access_key String The corresponding secret for the AWS Access Key to use for an instance. The value the operator entered for AWS Secret Access Key in Ops Manager. provision and update

Binding

You can bind a service by running:

cf bind-service APP-NAME SERVICE-INSTANCE-NAME --binding-name BINDING-NAME

The following table lists the parameters that you can configure, by using the -c flag, when binding a csb-aws-aurora-mysql service:

Parameter Name Type Description Default
reader_endpoint Boolean Whether to return the Aurora reader endpoint, which is balanced across Reader and Writer instances. By default the writer endpoint is returned, which maps only to the Writer instance. false

Binding Credentials

The format for binding credentials for Amazon Aurora MySQL-Compatible Edition is as follows:

{
    "database" : "DATABASE-NAME",
    "hostname" : "DATABASE-SERVER-HOST",
    "port" : "DATABASE-SERVER-PORT",
    "username" : "AUTHENTICATION-USERNAME",
    "password" : "AUTHENTICATION-PASSWORD",
    "uri" : "DATABASE-CONNECTION-URI",
    "jdbcUrl" : "JDBC-FORMAT-CONNECTION-URL"
}
check-circle-line exclamation-circle-line close-line
Scroll to top icon