This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.
redshift¶
This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.
- class
pulumi_aws.redshift.AwaitableGetClusterResult(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, id=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)¶
- class
pulumi_aws.redshift.AwaitableGetServiceAccountResult(arn=None, id=None, region=None)¶
- 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, __props__=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.
import pulumi import pulumi_aws as aws default = aws.redshift.Cluster("default", cluster_identifier="tf-redshift-cluster", cluster_type="single-node", database_name="mydb", master_password="Mustbe8characters", master_username="foo", node_type="dc1.large")
- 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-nodeormulti-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_snapshotmust 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,encryptedneeds 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 map 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.
The logging object supports the following:
bucket_name(pulumi.Input[str]) - The name of an existing S3 bucket where the log files are to be stored. Must be in the same region as the cluster and the cluster must have read bucket and put object permissions. For more information on the permissions required for the bucket, please read the AWS documentationenable(pulumi.Input[bool]) - Enables logging information such as queries and connection attempts, for the specified Amazon Redshift cluster.s3_key_prefix(pulumi.Input[str]) - The prefix applied to the log file names.
The snapshot_copy object supports the following:
destinationRegion(pulumi.Input[str]) - The destination region that you want to copy snapshots to.grantName(pulumi.Input[str]) - The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.retention_period(pulumi.Input[float]) - The number of days to retain automated snapshots in the destination region after they are copied from the source region. Defaults to7.
allow_version_upgrade: pulumi.Output[bool] = 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
arn: pulumi.Output[str] = None¶Amazon Resource Name (ARN) of cluster
automated_snapshot_retention_period: pulumi.Output[float] = 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: pulumi.Output[str] = 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: pulumi.Output[str] = None¶The Cluster Identifier. Must be a lower case string.
cluster_parameter_group_name: pulumi.Output[str] = None¶The name of the parameter group to be associated with this cluster.
cluster_public_key: pulumi.Output[str] = None¶The public key for the cluster
cluster_revision_number: pulumi.Output[str] = None¶The specific revision number of the database in the cluster
cluster_security_groups: pulumi.Output[list] = None¶A list of security groups to be associated with this cluster.
cluster_subnet_group_name: pulumi.Output[str] = 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: pulumi.Output[str] = None¶The cluster type to use. Either
single-nodeormulti-node.
cluster_version: pulumi.Output[str] = 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: pulumi.Output[str] = 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: pulumi.Output[str] = None¶The DNS name of the cluster
elastic_ip: pulumi.Output[str] = None¶The Elastic IP (EIP) address for the cluster.
encrypted: pulumi.Output[bool] = None¶If true , the data in the cluster is encrypted at rest.
endpoint: pulumi.Output[str] = None¶The connection endpoint
enhanced_vpc_routing: pulumi.Output[bool] = None¶If true , enhanced VPC routing is enabled.
final_snapshot_identifier: pulumi.Output[str] = None¶The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided,
skip_final_snapshotmust be false.
iam_roles: pulumi.Output[list] = 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: pulumi.Output[str] = None¶The ARN for the KMS encryption key. When specifying
kms_key_id,encryptedneeds to be set to true.
logging: pulumi.Output[dict] = None¶Logging, documented below.
bucket_name(str) - The name of an existing S3 bucket where the log files are to be stored. Must be in the same region as the cluster and the cluster must have read bucket and put object permissions. For more information on the permissions required for the bucket, please read the AWS documentationenable(bool) - Enables logging information such as queries and connection attempts, for the specified Amazon Redshift cluster.s3_key_prefix(str) - The prefix applied to the log file names.
master_password: pulumi.Output[str] = 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: pulumi.Output[str] = None¶Username for the master DB user.
node_type: pulumi.Output[str] = None¶The node type to be provisioned for the cluster.
number_of_nodes: pulumi.Output[float] = 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: pulumi.Output[str] = 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: pulumi.Output[float] = 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: pulumi.Output[str] = None¶The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi
publicly_accessible: pulumi.Output[bool] = None¶If true, the cluster can be accessed from a public network. Default is
true.
skip_final_snapshot: pulumi.Output[bool] = 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: pulumi.Output[str] = None¶The name of the cluster the source snapshot was created from.
snapshot_copy: pulumi.Output[dict] = None¶Configuration of automatic copy of snapshots from one region to another. Documented below.
destinationRegion(str) - The destination region that you want to copy snapshots to.grantName(str) - The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.retention_period(float) - The number of days to retain automated snapshots in the destination region after they are copied from the source region. Defaults to7.
snapshot_identifier: pulumi.Output[str] = None¶The name of the snapshot from which to create the new cluster.
A map of tags to assign to the resource.
vpc_security_group_ids: pulumi.Output[list] = None¶A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
- static
get(resource_name, id, opts=None, allow_version_upgrade=None, arn=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, dns_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)¶ Get an existing Cluster resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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
arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of cluster
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-nodeormulti-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.dns_name (pulumi.Input[str]) – The DNS name of the cluster
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_snapshotmust 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,encryptedneeds 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 map 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.
The logging object supports the following:
bucket_name(pulumi.Input[str]) - The name of an existing S3 bucket where the log files are to be stored. Must be in the same region as the cluster and the cluster must have read bucket and put object permissions. For more information on the permissions required for the bucket, please read the AWS documentationenable(pulumi.Input[bool]) - Enables logging information such as queries and connection attempts, for the specified Amazon Redshift cluster.s3_key_prefix(pulumi.Input[str]) - The prefix applied to the log file names.
The snapshot_copy object supports the following:
destinationRegion(pulumi.Input[str]) - The destination region that you want to copy snapshots to.grantName(pulumi.Input[str]) - The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.retention_period(pulumi.Input[float]) - The number of days to retain automated snapshots in the destination region after they are copied from the source region. Defaults to7.
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, __props__=None, __name__=None, __opts__=None)¶ Provides a Redshift event subscription resource.
import pulumi import pulumi_aws as aws default_cluster = aws.redshift.Cluster("defaultCluster", cluster_identifier="default", database_name="default") default_topic = aws.sns.Topic("defaultTopic") default_event_subscription = aws.redshift.EventSubscription("defaultEventSubscription", event_categories=[ "configuration", "management", "monitoring", "security", ], severity="INFO", sns_topic_arn=default_topic.arn, source_ids=[default_cluster.id], source_type="cluster", tags={ "Name": "default", })
The following additional atttributes are provided:
arn- Amazon Resource Name (ARN) of the Redshift event notification subscriptionid- The name of the Redshift event notification subscriptioncustomer_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
INFOorERROR.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, orcluster-snapshot. If not set, all sources will be subscribed to.tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
enabled: pulumi.Output[bool] = None¶A boolean flag to enable/disable the subscription. Defaults to true.
event_categories: pulumi.Output[list] = 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: pulumi.Output[str] = None¶The name of the Redshift event subscription.
severity: pulumi.Output[str] = None¶The event severity to be published by the notification subscription. Valid options are
INFOorERROR.
sns_topic_arn: pulumi.Output[str] = None¶The ARN of the SNS topic to send events to.
source_ids: pulumi.Output[list] = 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: pulumi.Output[str] = None¶The type of source that will be generating the events. Valid options are
cluster,cluster-parameter-group,cluster-security-group, orcluster-snapshot. If not set, all sources will be subscribed to.
A map of tags to assign to the resource.
- static
get(resource_name, id, opts=None, arn=None, customer_aws_id=None, enabled=None, event_categories=None, name=None, severity=None, sns_topic_arn=None, source_ids=None, source_type=None, status=None, tags=None)¶ Get an existing EventSubscription resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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
INFOorERROR.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, orcluster-snapshot. If not set, all sources will be subscribed to.tags (pulumi.Input[dict]) – A map 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, id=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)¶ 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
id= None¶The provider-assigned unique ID for this managed resource.
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
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
- class
pulumi_aws.redshift.GetServiceAccountResult(arn=None, id=None, region=None)¶ A collection of values returned by getServiceAccount.
arn= None¶The ARN of the AWS Redshift service account in the selected region.
id= None¶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, tags=None, __props__=None, __name__=None, __opts__=None)¶ Provides a Redshift Cluster parameter group resource.
import pulumi import pulumi_aws as aws bar = aws.redshift.ParameterGroup("bar", family="redshift-1.0", parameters=[ { "name": "require_ssl", "value": "true", }, { "name": "query_group", "value": "example", }, { "name": "enable_user_activity_logging", "value": "true", }, ])
- 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 Pulumi”.
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.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
The parameters object supports the following:
name(pulumi.Input[str]) - The name of the Redshift parameter.value(pulumi.Input[str]) - The value of the Redshift parameter.
arn: pulumi.Output[str] = None¶Amazon Resource Name (ARN) of parameter group
description: pulumi.Output[str] = None¶The description of the Redshift parameter group. Defaults to “Managed by Pulumi”.
family: pulumi.Output[str] = None¶The family of the Redshift parameter group.
name: pulumi.Output[str] = None¶The name of the Redshift parameter.
parameters: pulumi.Output[list] = None¶A list of Redshift parameters to apply.
name(str) - The name of the Redshift parameter.value(str) - The value of the Redshift parameter.
A map of tags to assign to the resource.
- static
get(resource_name, id, opts=None, arn=None, description=None, family=None, name=None, parameters=None, tags=None)¶ Get an existing ParameterGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of parameter group
description (pulumi.Input[str]) – The description of the Redshift parameter group. Defaults to “Managed by Pulumi”.
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.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
The parameters object supports the following:
name(pulumi.Input[str]) - The name of the Redshift parameter.value(pulumi.Input[str]) - The value of the Redshift parameter.
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, __props__=None, __name__=None, __opts__=None)¶ Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters
import pulumi import pulumi_aws as aws default = aws.redshift.SecurityGroup("default", ingress=[{ "cidr": "10.0.0.0/24", }])
- 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 Pulumi”.
ingress (pulumi.Input[list]) – A list of ingress rules.
name (pulumi.Input[str]) – The name of the Redshift security group.
The ingress object supports the following:
cidr(pulumi.Input[str]) - The CIDR block to acceptsecurityGroupName(pulumi.Input[str]) - The name of the security group to authorizesecurityGroupOwnerId(pulumi.Input[str]) - The owner Id of the security group provided bysecurity_group_name.
description: pulumi.Output[str] = None¶The description of the Redshift security group. Defaults to “Managed by Pulumi”.
ingress: pulumi.Output[list] = None¶A list of ingress rules.
cidr(str) - The CIDR block to acceptsecurityGroupName(str) - The name of the security group to authorizesecurityGroupOwnerId(str) - The owner Id of the security group provided bysecurity_group_name.
name: pulumi.Output[str] = None¶The name of the Redshift security group.
- static
get(resource_name, id, opts=None, description=None, ingress=None, name=None)¶ Get an existing SecurityGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – The description of the Redshift security group. Defaults to “Managed by Pulumi”.
ingress (pulumi.Input[list]) – A list of ingress rules.
name (pulumi.Input[str]) – The name of the Redshift security group.
The ingress object supports the following:
cidr(pulumi.Input[str]) - The CIDR block to acceptsecurityGroupName(pulumi.Input[str]) - The name of the security group to authorizesecurityGroupOwnerId(pulumi.Input[str]) - The owner Id of the security group provided bysecurity_group_name.
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, __props__=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.
import pulumi import pulumi_aws as aws test_snapshot_copy_grant = aws.redshift.SnapshotCopyGrant("testSnapshotCopyGrant", snapshot_copy_grant_name="my-grant") test_cluster = aws.redshift.Cluster("testCluster", snapshot_copy={ "destinationRegion": "us-east-2", "grantName": test_snapshot_copy_grant.snapshot_copy_grant_name, })
- 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 map of tags to assign to the resource.
arn: pulumi.Output[str] = None¶Amazon Resource Name (ARN) of snapshot copy grant
kms_key_id: pulumi.Output[str] = 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: pulumi.Output[str] = None¶A friendly name for identifying the grant.
A map of tags to assign to the resource.
- static
get(resource_name, id, opts=None, arn=None, kms_key_id=None, snapshot_copy_grant_name=None, tags=None)¶ Get an existing SnapshotCopyGrant resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of snapshot copy grant
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 map 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.SnapshotSchedule(resource_name, opts=None, definitions=None, description=None, force_destroy=None, identifier=None, identifier_prefix=None, tags=None, __props__=None, __name__=None, __opts__=None)¶ import pulumi import pulumi_aws as aws default = aws.redshift.SnapshotSchedule("default", definitions=["rate(12 hours)"], identifier="tf-redshift-snapshot-schedule")
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
definitions (pulumi.Input[list]) – The definition of the snapshot schedule. The definition is made up of schedule expressions, for example
cron(30 12 *)orrate(12 hours).description (pulumi.Input[str]) – The description of the snapshot schedule.
force_destroy (pulumi.Input[bool]) – Whether to destroy all associated clusters with this snapshot schedule on deletion. Must be enabled and applied before attempting deletion.
identifier (pulumi.Input[str]) – The snapshot schedule identifier. If omitted, this provider will assign a random, unique identifier.
identifier_prefix (pulumi.Input[str]) – Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier.tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
definitions: pulumi.Output[list] = None¶The definition of the snapshot schedule. The definition is made up of schedule expressions, for example
cron(30 12 *)orrate(12 hours).
description: pulumi.Output[str] = None¶The description of the snapshot schedule.
force_destroy: pulumi.Output[bool] = None¶Whether to destroy all associated clusters with this snapshot schedule on deletion. Must be enabled and applied before attempting deletion.
identifier: pulumi.Output[str] = None¶The snapshot schedule identifier. If omitted, this provider will assign a random, unique identifier.
identifier_prefix: pulumi.Output[str] = None¶Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier.
A map of tags to assign to the resource.
- static
get(resource_name, id, opts=None, arn=None, definitions=None, description=None, force_destroy=None, identifier=None, identifier_prefix=None, tags=None)¶ Get an existing SnapshotSchedule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
definitions (pulumi.Input[list]) – The definition of the snapshot schedule. The definition is made up of schedule expressions, for example
cron(30 12 *)orrate(12 hours).description (pulumi.Input[str]) – The description of the snapshot schedule.
force_destroy (pulumi.Input[bool]) – Whether to destroy all associated clusters with this snapshot schedule on deletion. Must be enabled and applied before attempting deletion.
identifier (pulumi.Input[str]) – The snapshot schedule identifier. If omitted, this provider will assign a random, unique identifier.
identifier_prefix (pulumi.Input[str]) – Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier.tags (pulumi.Input[dict]) – A map 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.SnapshotScheduleAssociation(resource_name, opts=None, cluster_identifier=None, schedule_identifier=None, __props__=None, __name__=None, __opts__=None)¶ import pulumi import pulumi_aws as aws default_cluster = aws.redshift.Cluster("defaultCluster", cluster_identifier="tf-redshift-cluster", cluster_type="single-node", database_name="mydb", master_password="Mustbe8characters", master_username="foo", node_type="dc1.large") default_snapshot_schedule = aws.redshift.SnapshotSchedule("defaultSnapshotSchedule", definitions=["rate(12 hours)"], identifier="tf-redshift-snapshot-schedule") default_snapshot_schedule_association = aws.redshift.SnapshotScheduleAssociation("defaultSnapshotScheduleAssociation", cluster_identifier=default_cluster.id, schedule_identifier=default_snapshot_schedule.id)
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
cluster_identifier (pulumi.Input[str]) – The cluster identifier.
schedule_identifier (pulumi.Input[str]) – The snapshot schedule identifier.
cluster_identifier: pulumi.Output[str] = None¶The cluster identifier.
schedule_identifier: pulumi.Output[str] = None¶The snapshot schedule identifier.
- static
get(resource_name, id, opts=None, cluster_identifier=None, schedule_identifier=None)¶ Get an existing SnapshotScheduleAssociation resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
cluster_identifier (pulumi.Input[str]) – The cluster identifier.
schedule_identifier (pulumi.Input[str]) – The snapshot schedule identifier.
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, __props__=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.
import pulumi import pulumi_aws as aws foo_vpc = aws.ec2.Vpc("fooVpc", cidr_block="10.1.0.0/16") foo_subnet = aws.ec2.Subnet("fooSubnet", availability_zone="us-west-2a", cidr_block="10.1.1.0/24", tags={ "Name": "tf-dbsubnet-test-1", }, vpc_id=foo_vpc.id) bar = aws.ec2.Subnet("bar", availability_zone="us-west-2b", cidr_block="10.1.2.0/24", tags={ "Name": "tf-dbsubnet-test-2", }, vpc_id=foo_vpc.id) foo_subnet_group = aws.redshift.SubnetGroup("fooSubnetGroup", subnet_ids=[ foo_subnet.id, bar.id, ], tags={ "environment": "Production", })
- 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 Pulumi”.
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 map of tags to assign to the resource.
arn: pulumi.Output[str] = None¶Amazon Resource Name (ARN) of the Redshift Subnet group name
description: pulumi.Output[str] = None¶The description of the Redshift Subnet group. Defaults to “Managed by Pulumi”.
name: pulumi.Output[str] = None¶The name of the Redshift Subnet group.
subnet_ids: pulumi.Output[list] = None¶An array of VPC subnet IDs.
A map of tags to assign to the resource.
- static
get(resource_name, id, opts=None, arn=None, description=None, name=None, subnet_ids=None, tags=None)¶ Get an existing SubnetGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the Redshift Subnet group name
description (pulumi.Input[str]) – The description of the Redshift Subnet group. Defaults to “Managed by Pulumi”.
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 map 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.
import pulumi import pulumi_aws as aws test_cluster = aws.redshift.get_cluster(cluster_identifier="test-cluster") test_stream = aws.kinesis.FirehoseDeliveryStream("testStream", destination="redshift", redshift_configuration={ "clusterJdbcurl": f"jdbc:redshift://{test_cluster.endpoint}/{test_cluster.database_name}", "copyOptions": "delimiter '|'", "dataTableColumns": "test-col", "dataTableName": "test-table", "password": "T3stPass", "role_arn": aws_iam_role["firehose_role"]["arn"], "username": "testuser", }, s3_configuration={ "bucketArn": aws_s3_bucket["bucket"]["arn"], "bufferInterval": 400, "bufferSize": 10, "compressionFormat": "GZIP", "role_arn": aws_iam_role["firehose_role"]["arn"], })
- Parameters
cluster_identifier (str) – The cluster identifier
tags (dict) – The tags associated to the 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.
import pulumi import pulumi_aws as aws main = aws.redshift.get_service_account() bucket = aws.s3.Bucket("bucket", force_destroy=True, policy=f"""{{ "Version": "2008-10-17", "Statement": [ {{ "Sid": "Put bucket policy needed for audit logging", "Effect": "Allow", "Principal": {{ "AWS": "{main.arn}" }}, "Action": "s3:PutObject", "Resource": "arn:aws:s3:::tf-redshift-logging-test-bucket/*" }}, {{ "Sid": "Get bucket policy needed for audit logging ", "Effect": "Allow", "Principal": {{ "AWS": "{main.arn}" }}, "Action": "s3:GetBucketAcl", "Resource": "arn:aws:s3:::tf-redshift-logging-test-bucket" }} ] }} """)
- Parameters
region (str) – Name of the region whose AWS Redshift account ID is desired. Defaults to the region from the AWS provider configuration.