Cloud.Service.AWS.Redshift.Cluster

JSON Example

{
    "account": "string",
    "allow_version_upgrade": false,
    "automated_snapshot_retention_period": 0,
    "availability_zone": "string",
    "bucket_name": "string",
    "cluster_identifier": "string",
    "cluster_parameter_group_name": "string",
    "cluster_public_key": "string",
    "cluster_revision_number": "string",
    "cluster_security_groups": [
        "string"
    ],
    "cluster_subnet_group_name": "string",
    "cluster_type": "string",
    "cluster_version": "string",
    "count": 0,
    "database_name": "string",
    "dns_name": "string",
    "elastic_ip": "string",
    "enable_logging": false,
    "encrypted": false,
    "endpoint": "string",
    "enhanced_vpc_routing": false,
    "final_snapshot_identifier": "string",
    "iam_roles": [
        "string"
    ],
    "kms_key_id": "string",
    "logging": [
        {
            "bucket_name": "string",
            "enable": false,
            "s3_key_prefix": "string"
        }
    ],
    "master_password": "string",
    "master_username": "string",
    "node_type": "string",
    "number_of_nodes": 0,
    "owner_account": "string",
    "port": 0,
    "preferred_maintenance_window": "string",
    "publicly_accessible": false,
    "region": "string",
    "s3_key_prefix": "string",
    "skip_final_snapshot": false,
    "snapshot_cluster_identifier": "string",
    "snapshot_copy": [
        {
            "destination_region": "string",
            "grant_name": "string",
            "retention_period": 0
        }
    ],
    "snapshot_identifier": "string",
    "vpc_security_group_ids": [
        "string"
    ]
}

string

account

Required

(Required) The name of the AWS cloud account to use for this resource

boolean

allow_version_upgrade

Optional

Whether major Redshift engine version upgrades are applied to the cluster immediately or during the next maintenance window. Default is false (next window).

integer

automated_snapshot_retention_period

Optional

Lifespan, in days, of automated snapshots. Default is 1. Set to 0 to disable automated snapshots. (When disabled, you can still create manual snapshots with create-cluster-snapshot.)

string

availability_zone

Optional

EC2 availability zone in which to host the cluster.If you have several EC2 instances running in an availability zone, consider placing the cluster in the same instance for lower latency.

string

bucket_name

Optional

The Bucket Name property for this resource

string

cluster_identifier

Required

(Required) User-assigned identifier for the cluster. Must be all lower case.

string

cluster_parameter_group_name

Optional

Parameter group to associate with the cluster.

string

cluster_public_key

Optional

In key pair authentication, the public SSL key for the cluster.

string

cluster_revision_number

Optional

Revision number of the database in the cluster.

array of string

cluster_security_groups

Optional

List of non-VPC security groups to associate with the cluster.

string

cluster_subnet_group_name

Optional

Cluster subnet group to associate with the cluster. When omitted, the cluster is deployed outside of the VPC.

string

cluster_type

Optional

Cluster type of single-node or multi-node.

string

cluster_version

Optional

Redshift engine software version to deploy on the cluster.

integer

count

Optional

The number of resource instances to be created.

string

database_name

Optional

Upon cluster creation, name for the automatically created database.

string

dns_name

Optional

DNS name of the Redshift cluster.

string

elastic_ip

Optional

Elastic IP (EIP) address of the Redshift cluster.

boolean

enable_logging

Optional

The Enable Logging property for this resource

boolean

encrypted

Optional

Whether to encrypt data stored on the redshift cluster. Default is false.

string

endpoint

Optional

Endpoint that is connecting to the cluster for data storage.

boolean

enhanced_vpc_routing

Optional

Whether to use enhanced Virtual Private Cloud (VPC) routing.

string

final_snapshot_identifier

Optional

Name for the final cluster snapshot.

array of string

iam_roles

Optional

ARNs of the IAM roles with permission to access the cluster. Maximum of 10.

string

kms_key_id

Optional

ARN for the KMS encryption key. Encryption must be enabled.

array of object

logging

Optional

Settings for log storage.

string

master_password

Optional

Master database user account password. Optional only if using snapshot_identifier.

string

master_username

Optional

Master database user account. Optional only if using snapshot_identifier.

string

node_type

Required

(Required) Node type to be provisioned for the cluster: leader or compute.

integer

number_of_nodes

Optional

For multi-node clusters, number of compute nodes in the cluster. Default is 1.

string

owner_account

Optional

AWS customer account used to create or copy the snapshot. Required when restoring a snapshot you do not own, optional if you own the snapshot.

integer

port

Optional

Port on which the Redshift cluster accepts connections.

string

preferred_maintenance_window

Optional

Weekly time range, in UTC, during which system maintenance can occur. For example: Wed:04:00-Wed:04:30

boolean

publicly_accessible

Optional

Whether the cluster can be accessed from a public network. Default is true.

string

region

Required

(Required) Target cloud region, such as us-east-1. Must be within the provider cloud account.

string

s3_key_prefix

Optional

The S3 Key Prefix property for this resource

boolean

skip_final_snapshot

Optional

Whether to prevent a final snapshot before the Redshift cluster is deleted. Default is false. (Before deletion, a snapshot is created according to the value from final_snapshot_identifier.)

string

snapshot_cluster_identifier

Optional

Cluster that the source snapshot came from.

array of object

snapshot_copy

Optional

Settings for copying snapshots from one region to another.

string

snapshot_identifier

Optional

Snapshot from which to create the new cluster.

object