redshift

class pulumi_aws.redshift.Cluster(resource_name, opts=None, allow_version_upgrade=None, automated_snapshot_retention_period=None, availability_zone=None, cluster_identifier=None, cluster_parameter_group_name=None, cluster_public_key=None, cluster_revision_number=None, cluster_security_groups=None, cluster_subnet_group_name=None, cluster_type=None, cluster_version=None, database_name=None, elastic_ip=None, encrypted=None, endpoint=None, enhanced_vpc_routing=None, final_snapshot_identifier=None, iam_roles=None, kms_key_id=None, logging=None, master_password=None, master_username=None, node_type=None, number_of_nodes=None, owner_account=None, port=None, preferred_maintenance_window=None, publicly_accessible=None, skip_final_snapshot=None, snapshot_cluster_identifier=None, snapshot_copy=None, snapshot_identifier=None, tags=None, vpc_security_group_ids=None, __name__=None, __opts__=None)

Provides a Redshift Cluster Resource.

Note: All arguments including the username and password will be stored in the raw state as plain-text. Read more about sensitive data in state.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • allow_version_upgrade (pulumi.Input[bool]) – If true , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default is true
  • automated_snapshot_retention_period (pulumi.Input[float]) – The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with create-cluster-snapshot. Default is 1.
  • availability_zone (pulumi.Input[str]) – The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
  • cluster_identifier (pulumi.Input[str]) – The Cluster Identifier. Must be a lower case string.
  • cluster_parameter_group_name (pulumi.Input[str]) – The name of the parameter group to be associated with this cluster.
  • cluster_public_key (pulumi.Input[str]) – The public key for the cluster
  • cluster_revision_number (pulumi.Input[str]) – The specific revision number of the database in the cluster
  • cluster_security_groups (pulumi.Input[list]) – A list of security groups to be associated with this cluster.
  • cluster_subnet_group_name (pulumi.Input[str]) – The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
  • cluster_type (pulumi.Input[str]) – The cluster type to use. Either single-node or multi-node.
  • cluster_version (pulumi.Input[str]) – The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster.
  • database_name (pulumi.Input[str]) – The name of the first database to be created when the cluster is created. If you do not provide a name, Amazon Redshift will create a default database called dev.
  • elastic_ip (pulumi.Input[str]) – The Elastic IP (EIP) address for the cluster.
  • encrypted (pulumi.Input[bool]) – If true , the data in the cluster is encrypted at rest.
  • endpoint (pulumi.Input[str]) – The connection endpoint
  • enhanced_vpc_routing (pulumi.Input[bool]) – If true , enhanced VPC routing is enabled.
  • final_snapshot_identifier (pulumi.Input[str]) – The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, skip_final_snapshot must be false.
  • iam_roles (pulumi.Input[list]) – A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time.
  • kms_key_id (pulumi.Input[str]) – The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
  • logging (pulumi.Input[dict]) – Logging, documented below.
  • master_password (pulumi.Input[str]) – Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 chars and contain at least one uppercase letter, one lowercase letter, and one number.
  • master_username (pulumi.Input[str]) – Username for the master DB user.
  • node_type (pulumi.Input[str]) – The node type to be provisioned for the cluster.
  • number_of_nodes (pulumi.Input[float]) – The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1.
  • owner_account (pulumi.Input[str]) – The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
  • port (pulumi.Input[float]) – The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default port is 5439.
  • preferred_maintenance_window (pulumi.Input[str]) – The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi
  • publicly_accessible (pulumi.Input[bool]) – If true, the cluster can be accessed from a public network. Default is true.
  • skip_final_snapshot (pulumi.Input[bool]) – Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true , a final cluster snapshot is not created. If false , a final cluster snapshot is created before the cluster is deleted. Default is false.
  • snapshot_cluster_identifier (pulumi.Input[str]) – The name of the cluster the source snapshot was created from.
  • snapshot_copy (pulumi.Input[dict]) – Configuration of automatic copy of snapshots from one region to another. Documented below.
  • snapshot_identifier (pulumi.Input[str]) – The name of the snapshot from which to create the new cluster.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
  • vpc_security_group_ids (pulumi.Input[list]) – A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
allow_version_upgrade = None

If true , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default is true

automated_snapshot_retention_period = None

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with create-cluster-snapshot. Default is 1.

availability_zone = None

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

cluster_identifier = None

The Cluster Identifier. Must be a lower case string.

cluster_parameter_group_name = None

The name of the parameter group to be associated with this cluster.

cluster_public_key = None

The public key for the cluster

cluster_revision_number = None

The specific revision number of the database in the cluster

cluster_security_groups = None

A list of security groups to be associated with this cluster.

cluster_subnet_group_name = None

The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

cluster_type = None

The cluster type to use. Either single-node or multi-node.

cluster_version = None

The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster.

database_name = None

The name of the first database to be created when the cluster is created. If you do not provide a name, Amazon Redshift will create a default database called dev.

dns_name = None

The DNS name of the cluster

elastic_ip = None

The Elastic IP (EIP) address for the cluster.

encrypted = None

If true , the data in the cluster is encrypted at rest.

endpoint = None

The connection endpoint

enhanced_vpc_routing = None

If true , enhanced VPC routing is enabled.

final_snapshot_identifier = None

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, skip_final_snapshot must be false.

iam_roles = None

A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time.

kms_key_id = None

The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.

logging = None

Logging, documented below.

master_password = None

Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 chars and contain at least one uppercase letter, one lowercase letter, and one number.

master_username = None

Username for the master DB user.

node_type = None

The node type to be provisioned for the cluster.

number_of_nodes = None

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1.

owner_account = None

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

port = None

The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default port is 5439.

preferred_maintenance_window = None

The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi

publicly_accessible = None

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

skip_final_snapshot = None

Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true , a final cluster snapshot is not created. If false , a final cluster snapshot is created before the cluster is deleted. Default is false.

snapshot_cluster_identifier = None

The name of the cluster the source snapshot was created from.

snapshot_copy = None

Configuration of automatic copy of snapshots from one region to another. Documented below.

snapshot_identifier = None

The name of the snapshot from which to create the new cluster.

tags = None

A mapping of tags to assign to the resource.

vpc_security_group_ids = None

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.redshift.EventSubscription(resource_name, opts=None, enabled=None, event_categories=None, name=None, severity=None, sns_topic_arn=None, source_ids=None, source_type=None, tags=None, __name__=None, __opts__=None)

Provides a Redshift event subscription resource.

The following additional atttributes are provided:

  • id - The name of the Redshift event notification subscription
  • customer_aws_id - The AWS customer account associated with the Redshift event notification subscription
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • enabled (pulumi.Input[bool]) – A boolean flag to enable/disable the subscription. Defaults to true.
  • event_categories (pulumi.Input[list]) – A list of event categories for a SourceType that you want to subscribe to. See https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html or run aws redshift describe-event-categories.
  • name (pulumi.Input[str]) – The name of the Redshift event subscription.
  • severity (pulumi.Input[str]) – The event severity to be published by the notification subscription. Valid options are INFO or ERROR.
  • sns_topic_arn (pulumi.Input[str]) – The ARN of the SNS topic to send events to.
  • source_ids (pulumi.Input[list]) – A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a source_type must also be specified.
  • source_type (pulumi.Input[str]) – The type of source that will be generating the events. Valid options are cluster, cluster-parameter-group, cluster-security-group, or cluster-snapshot. If not set, all sources will be subscribed to.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
enabled = None

A boolean flag to enable/disable the subscription. Defaults to true.

event_categories = None

A list of event categories for a SourceType that you want to subscribe to. See https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html or run aws redshift describe-event-categories.

name = None

The name of the Redshift event subscription.

severity = None

The event severity to be published by the notification subscription. Valid options are INFO or ERROR.

sns_topic_arn = None

The ARN of the SNS topic to send events to.

source_ids = None

A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a source_type must also be specified.

source_type = None

The type of source that will be generating the events. Valid options are cluster, cluster-parameter-group, cluster-security-group, or cluster-snapshot. If not set, all sources will be subscribed to.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.redshift.GetClusterResult(allow_version_upgrade=None, automated_snapshot_retention_period=None, availability_zone=None, bucket_name=None, cluster_identifier=None, cluster_parameter_group_name=None, cluster_public_key=None, cluster_revision_number=None, cluster_security_groups=None, cluster_subnet_group_name=None, cluster_type=None, cluster_version=None, database_name=None, elastic_ip=None, enable_logging=None, encrypted=None, endpoint=None, enhanced_vpc_routing=None, iam_roles=None, kms_key_id=None, master_username=None, node_type=None, number_of_nodes=None, port=None, preferred_maintenance_window=None, publicly_accessible=None, s3_key_prefix=None, tags=None, vpc_id=None, vpc_security_group_ids=None, id=None)

A collection of values returned by getCluster.

allow_version_upgrade = None

Whether major version upgrades can be applied during maintenance period

automated_snapshot_retention_period = None

The backup retention period

availability_zone = None

The availability zone of the cluster

bucket_name = None

The name of the S3 bucket where the log files are to be stored

cluster_identifier = None

The cluster identifier

cluster_parameter_group_name = None

The name of the parameter group to be associated with this cluster

cluster_public_key = None

The public key for the cluster

cluster_revision_number = None

The cluster revision number

cluster_security_groups = None

The security groups associated with the cluster

cluster_subnet_group_name = None

The name of a cluster subnet group to be associated with this cluster

cluster_type = None

The cluster type

database_name = None

The name of the default database in the cluster

elastic_ip = None

The Elastic IP of the cluster

enable_logging = None

Whether cluster logging is enabled

encrypted = None

Whether the cluster data is encrypted

endpoint = None

The cluster endpoint

enhanced_vpc_routing = None

Whether enhanced VPC routing is enabled

iam_roles = None

The IAM roles associated to the cluster

kms_key_id = None

The KMS encryption key associated to the cluster

master_username = None

Username for the master DB user

node_type = None

The cluster node type

number_of_nodes = None

The number of nodes in the cluster

port = None

The port the cluster responds on

preferred_maintenance_window = None

The maintenance window

publicly_accessible = None

Whether the cluster is publicly accessible

s3_key_prefix = None

The folder inside the S3 bucket where the log files are stored

tags = None

The tags associated to the cluster

vpc_id = None

The VPC Id associated with the cluster

vpc_security_group_ids = None

The VPC security group Ids associated with the cluster

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.redshift.GetServiceAccountResult(arn=None, region=None, id=None)

A collection of values returned by getServiceAccount.

arn = None

The ARN of the AWS Redshift service account in the selected region.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.redshift.ParameterGroup(resource_name, opts=None, description=None, family=None, name=None, parameters=None, __name__=None, __opts__=None)

Provides a Redshift Cluster parameter group resource.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – The description of the Redshift parameter group. Defaults to “Managed by Terraform”.
  • family (pulumi.Input[str]) – The family of the Redshift parameter group.
  • name (pulumi.Input[str]) – The name of the Redshift parameter.
  • parameters (pulumi.Input[list]) – A list of Redshift parameters to apply.
description = None

The description of the Redshift parameter group. Defaults to “Managed by Terraform”.

family = None

The family of the Redshift parameter group.

name = None

The name of the Redshift parameter.

parameters = None

A list of Redshift parameters to apply.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.redshift.SecurityGroup(resource_name, opts=None, description=None, ingress=None, name=None, __name__=None, __opts__=None)

Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – The description of the Redshift security group. Defaults to “Managed by Terraform”.
  • ingress (pulumi.Input[list]) – A list of ingress rules.
  • name (pulumi.Input[str]) – The name of the Redshift security group.
description = None

The description of the Redshift security group. Defaults to “Managed by Terraform”.

ingress = None

A list of ingress rules.

name = None

The name of the Redshift security group.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.redshift.SnapshotCopyGrant(resource_name, opts=None, kms_key_id=None, snapshot_copy_grant_name=None, tags=None, __name__=None, __opts__=None)

Creates a snapshot copy grant that allows AWS Redshift to encrypt copied snapshots with a customer master key from AWS KMS in a destination region.

Note that the grant must exist in the destination region, and not in the region of the cluster.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • kms_key_id (pulumi.Input[str]) – The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN. If not specified, the default key is used.
  • snapshot_copy_grant_name (pulumi.Input[str]) – A friendly name for identifying the grant.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
kms_key_id = None

The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN. If not specified, the default key is used.

snapshot_copy_grant_name = None

A friendly name for identifying the grant.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.redshift.SubnetGroup(resource_name, opts=None, description=None, name=None, subnet_ids=None, tags=None, __name__=None, __opts__=None)

Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • description (pulumi.Input[str]) – The description of the Redshift Subnet group. Defaults to “Managed by Terraform”.
  • name (pulumi.Input[str]) – The name of the Redshift Subnet group.
  • subnet_ids (pulumi.Input[list]) – An array of VPC subnet IDs.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
description = None

The description of the Redshift Subnet group. Defaults to “Managed by Terraform”.

name = None

The name of the Redshift Subnet group.

subnet_ids = None

An array of VPC subnet IDs.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_aws.redshift.get_cluster(cluster_identifier=None, tags=None, opts=None)

Provides details about a specific redshift cluster.

pulumi_aws.redshift.get_service_account(region=None, opts=None)

Use this data source to get the Account ID of the AWS Redshift Service Account in a given region for the purpose of allowing Redshift to store audit data in S3.