This topic provides reference information about the plans and configuration parameters used for configuring service instances.

See the section below for the service that you want:

Amazon S3 Bucket

This section applies to the csb-aws-s3-bucket service. This section lists default plans and configuration options for Amazon S3 Buckets on AWS.

You can provision a service by running:

cf create-service csb-aws-s3-bucket 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 -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'

Amazon S3 Bucket Plans

The table below lists the plans for the csb-aws-s3-bucket service:

Plan Description
private Private S3 bucket
public-read Publicly readable S3 bucket

Amazon S3 Bucket Plan Configuration Parameters

The table below lists the parameters that you can configure in Ops Manager. You can also configure these parameters using the -c flag when provisioning a csb-aws-s3-bucket service:

Parameter Name Type Description Default
bucket_name string The name of bucket to create. csb-INSTANCE-ID
region string The AWS region to deploy the service in. For more information about available regions, see the AWS documentation. us-west-2
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.
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.

Amazon S3 Bucket Binding Credentials

The format for binding credentials for Amazon S3 Bucket is as follows:

{
    "arn" : "BUCKET-ARN",
    "bucket_domain_name" : "BUCKET-FQDN",
    "region" : "BUCKET-REGION",
    "bucket_name" : "BUCKET-NAME",
    "access_key_id" : "ACCESS-KEY-FOR-BUCKET",
    "secret_access_key" : "SECRET-KEY-FOR-BUCKET"
}

Amazon RDS for MySQL

This section applies to the aws-rds-mysql service. This section lists default plans and configuration options for Amazon RDS for MySQL on AWS.

You can provision a service by running:

cf create-service aws-rds-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 -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'

Amazon RDS for MySQL Plans

The default plans and configuration options for Amazon RDS for MySQL are in the table below:

Plan Instance Class Version CPUs Memory Size Disk Size
small db.t2.medium 5.7 2 minimum 4 GB 5 GB
medium db.m4.xlarge 5.7 4 minimum 8 GB 10 GB
large db.m4.2xlarge 5.7 8 minimum 16 GB 20 GB

Amazon RDS for MySQL Core to Instance Class Mapping

The table below shows the CPU size mapped to AWS database instance types:

CPUs Instance class
1 db.m1.medium
2 db.t2.medium
4 db.m4.xlarge
8 db.m4.2xlarge
16 db.m4.4xlarge
32 db.m5.8xlarge
64 db.m5.16xlarge

For more information about database instance classes, see the AWS documentation.

Amazon RDS for MySQL Plan Configuration Parameters

The table below lists the parameters that you can configure in Ops Manager. You can also configure these parameters using the -c flag when provisioning a aws-rds-mysql service:

Parameter Name Type Description Default
instance_name string The name of the AWS instance to create. csb-mysql-INSTANCE-ID
region string The AWS region to deploy the service in. For more information about available regions, see the AWS documentation. us-west-2
aws_vpc_id string The Virtual Private Cloud (VPC) to connect the instance to. The default VPC
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.
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.
instance_class string Specifying the instance class overrides the conversion of cores to instance classes that is described in the Core to Instance Class Mapping table in the Plans for MySQL section above.

For more information about database instance classes, see the AWS documentation.
n/a
multi-az boolean If true, create a Multi-AZ (HA) instance. For more information about Multi-AZ deployment, see the AWS documentation. false
publicly_accessible boolean If true, make instance available to public connections. false
allow_major_version_upgrade boolean Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. true
auto_minor_version_upgrade boolean (Optional) Indicates that minor engine upgrades will be applied automatically to the database instance during the maintenance window. true
maintenance_day,
maintenance_start_hour,
maintenance_start_min,
maintenance_end_hour,
maintenance_end_min
boolean (Optional) Maintenance window definition. Defaults vary by region. See the AWS Documentation.
storage_encrypted boolean If true, database storage is encrypted. false
parameter_group_name string The MySQL parameter group name for the service instance. default.mysql.MYSQL-VERSION
rds_subnet_group string The name of subnet to attach the database instance to. This overrides aws_vpc_id. None
rds_vpc_security_group_ids comma separated string Security group IDs to assign to the database instance. None
use_tls boolean Use TLS for database connections. true
storage_autoscale boolean Enable storage autoscaling up to storage_autoscale_limit_gb. false
storage_autoscale_limit_gb number Max storage size if storage_autoscale is enabled. 0
db_name string The name of the database. vsbdb

Amazon RDS for MySQL Binding Credentials

The format for binding credentials for MySQL is as follows:

{
    "name" : "DATABASE-NAME",
    "hostname" : "DATABASE-SERVER-HOST",
    "port" : "DATABASE-SERVER-PORT",
    "username" : "AUTHENTICATION-USERNAME",
    "password" : "AUTHENTICATION-PASSWORD",
    "uri" : "DATABASE-CONNECTION-URI",
    "jdbcUrl" : "JDBC-FORMAT-CONNECTION-URI"
}

Amazon RDS for PostgreSQL

This section applies to the aws-rds-postgres service. This section lists default plans and configuration options for Amazon RDS for PostgreSQL on AWS.

You can provision a service by running:

cf create-service aws-rds-postgres 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 -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'

Amazon RDS for PostgreSQL Plan

The default plans and configuration options for Amazon RDS for PostgreSQL are in the table below:

Plan Instance Class Version CPUs Memory Size Disk Size
small db.t2.medium 11 2 minimum 4 GB 5 GB
medium db.m4.xlarge 11 4 minimum 8 GB 10 GB
large db.m4.2xlarge 11 8 minimum 16 GB 20 GB

Amazon RDS for PostgreSQL Core to Instance Class Mapping

The table below shows the CPU size mapped to AWS database instance types:

CPUs Instance Class
1 db.m1.medium
2 db.t2.medium
4 db.m4.xlarge
8 db.m4.2xlarge
16 db.m4.4xlarge
32 db.m5.8xlarge
64 db.m5.16xlarge

For more information about database instance classes, see the AWS documentation.

Amazon RDS for PostgreSQL Plan Configuration Parameters

The table below lists the parameters that you can configure in Ops Manager. You can also configure these parameters using the -c flag when provisioning a aws-rds-postgres service:

Parameter Name Type Description Default
instance_name string The name of the AWS instance to create. csb-mysql-INSTANCE-ID
region string The AWS region in which to deploy the service. For more information about available regions, see the AWS documentation. us-west-2
vpc_id string The Virtual Private Cloud (VPC) to connect the instance to. The default VPC
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.
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.
instance_class string Specifying the instance class overrides the conversion of cores to instance classes that is described in the Core to Instance Class Mapping table in the Plans for PostgreSQL section above.

For more information about database instance classes, see the AWS documentation.
n/a
multi-az boolean If true, create a Multi-AZ (HA) instance. For more information about Multi-AZ deployments, see the AWS documentation. false
publicly_accessible boolean If true, make instance available to public connections. false
allow_major_version_upgrade boolean Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. true
allow_minor_version_upgrade boolean (Optional) Indicates that minor engine upgrades will be applied automatically to the database instance during the maintenance window. true
maintenance_day,
maintenance_start_hour,
maintenance_start_min,
maintenance_end_hour,
maintenance_end_min
boolean (Optional) Maintenance window definition. Defaults vary by region. See the AWS Documentation.
storage_encrypted boolean If true, database storage is encrypted. false
parameter_group_name string The PostgreSQL parameter group name for the service instance. default.postgres.POSTGRES-VERSION
rds_subnet_group string The name of subnet to attach the database instance to. This overrides aws_vpc_id. None
rds_vpc_security_group_ids comma separated string Security group IDs to assign to the database instance. None
use_tls boolean Use TLS for database connections. true

Amazon RDS for PostgreSQL Binding Credentials

The format for binding credentials for PostgreSQL is as follows:

{
    "name" : "DATABASE-NAME",
    "hostname" : "DATABASE-SERVER-HOST",
    "port" : "DATABASE-SERVER-PORT",
    "username" : "AUTHENTICATION-USERNAME",
    "password" : "AUTHENTICATION-PASSWORD",
    "uri" : "DATABASE-CONNECTION-URI",
    "jdbcUrl" : "JDBC-FORMAT-CONNECTION-URI"
}

Amazon ElastiCache for Redis

This section applies to the csb-aws-redis service. This section lists default plans and configuration options for Amazon ElastiCache for Redis.

You can provision a service by running:

cf create-service csb-aws-redis 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 -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'

Amazon ElastiCache for Redis Plans

Tables for cache sizes and plans are below:

Cache Size to AWS Node Type Mapping

cache_size node type
1 cache.t2.small
2 cache.t3.medium
4 cache.m5.large
8 cache.m5.xlarge
16 cache.r4.xlarge
32 cache.r4.2xlarge
64 cache.r4.4xlarge
128 cache.r4.8xlarge
256 cache.r5.12xlarge

Basic Plans

Plan Cache Size AWS Cache Node Type HA
small minimum 1 GB cache.t2.small no
medium minimum 4 GB cache.m5.large no
large minimum 16 GB cache.r4.xlarge no

High Availability Plans

Plan Cache Size AWS Cache Node Type HA
small-ha minimum 1 GB cache.t2.small yes
medium-ha minimum 4 GB cache.m5.large yes
large-ha minimum 16 GB cache.r4.xlarge yes

Amazon ElastiCache for Redis Plan Configuration Parameters

The table below lists the parameters that you can configure in Ops Manager. You can also configure these parameters using the -c flag when provisioning a csb-aws-redis service:

Parameter Name Type Description Default
instance_name string The name of the AWS instance to create. csb-redis-INSTANCE-ID
region string The AWS region to deploy the service in. For more information about available regions, see the AWS documentation. us-west-2
vpc_id string The Virtual Private Cloud (VPC) to connect the instance to. The default VPC
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.
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.
redis_version string Redis version to provision: "2.6", "2.8", "3.2", "4.0", "5.0" "5.0"
cache_size integer The size in GB for the cache: 1, 2, 4, 8, 16, 32, 64, 128, 256 The default for the plan you selected.
node_type string Specifying the node type overrides the cache-size conversion to node type that is described in the Cache Size to AWS Node Type Mapping table in the Plans for Amazon ElastiCache section above.

For more information about node types and pricing, see the AWS documentation.
n/a

Amazon ElastiCache for Redis Binding Credentials

The format for binding credentials for Redis is as follows:

{
    "host" : "REDIS-SERVER-HOSTNAME",
    "port" : "REDIS-SERVER-PORT",
    "password" : "AUTHENTICATION-PASSWORD",
    "tls_port" : "REDIS-TLS-PORT"
}

Amazon DynamoDB

This section applies to the csb-aws-dynamodb service. This section lists default plans and configuration options for Amazon DynamoDB.

You can provision an Amazon DynamoDB table by running:

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

For example:

cf create-service csb-aws-dynamodb ondemand my-service -c '
{
  "attributes": [
    {"name":"id","type":"S"},
    {"name":"key","type":"S"},
    {"name":"value","type":"S"}
  ],
  "global_secondary_indexes": [
    {
      "hash_key": "key",
      "name": "KeyIndex",
      "non_key_attributes": ["id"],
      "projection_type": "INCLUDE",
      "range_key": "value"
    }
  ],
  "hash_key": "id",
  "range_key": "value",
  "table_name": "csb-dynamodb-test"
}'

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

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

Amazon DynamoDB Plans

The default plans for Amazon DynamoDB are in the table below:

Plan Billing Mode
ondemand With on-demand capacity mode, DynamoDB is charged for the data reads and writes the application performs on the table.
provisioned With provisioned capacity mode, specify the number of reads and writes per second that the application is expected to require.

Amazon DynamoDB Plan Configuration Parameters

The table below lists the parameters that you can configure in Ops Manager. You can also configure these parameters using the -c flag when provisioning a csb-aws-dynamodb service:

Parameter Name Type Required Description Default
table_name string yes The name of the table n/a
hash_key string yes The key to use as the hash key n/a
range_key string yes The key to use as the range key n/a
attributes array yes A list of attributes and their types, for example:
[{“name”:“id”, “type”:“S”}, {“name”:“value”, “type”:“S”}]
n/a
global_secondary_indexes array yes A list of global secondary indexes, for example:
[{“name”:“KeyIndex”, “hash_key”:“key”, “range_key”:“value”, “projection_type”:“INCLUDE”, “non_key_attributes”:[“id”]}]
n/a
local_secondary_indexes array no A list of local secondary indexes, for example:
[{“name”:“KeyIndex”, “hash_key”:“key”, “range_key”:“value”, “projection_type”:“INCLUDE”, “non_key_attributes”:[“id”]}]
n/a
instance_name string no The name of the AWS instance to create csb-dynamodb-INSTANCE-ID
region string no This is the AWS region to deploy the service in. For more information about available regions, see the AWS documentation. us-west-2
ttl_enabled boolean no Whether TTL is enabled false
ttl_attribute_name string no The name of the table attribute to store the TTL timestamp in ""
stream_enabled boolean no Indicates whether Streams are to be enabled false
stream_view_type string no Valid values are KEYS_ONLY, NEW_IMAGE, OLD_IMAGE, NEW_AND_OLD_IMAGES null
server_side_encryption_enabled boolean no Whether or not to enable encryption at rest using an AWS-managed KMS customer master key (CMK). false
server_side_encryption_kms_key_arn string no The ARN of the CMK that should be used for the AWS KMS encryption. This attribute should only be specified if the key is different from the default DynamoDB CMK, alias/aws/dynamodb. null
write_capacity number no The number of write units for this table. If billing_mode is PROVISIONED, this field should be greater than 0. n/a
read_capacity number no The number of read units for this table. If billing_mode is PROVISIONED, this field should be greater than 0. n/a

Amazon DynamoDB Binding Credentials

The format for binding credentials for DynamoDB is as follows:

{
    "access_key_id" : "AWS-ACCESS-KEY-ID",
    "secret_access_key" : "AWS-SECRET-ACCESS-KEY",
    "region" : "AWS-REGION",
    "dynamodb_table_name": "DYNAMODB-TABLE-NAME",
    "dynamodb_table_arn" : "DYNAMODB-TABLE-ARN",
    "dynamodb_table_id" : "DYNAMODB-TABLE-ID"
}
check-circle-line exclamation-circle-line close-line
Scroll to top icon