Module redshift

@pulumi/aws > redshift

Index

redshift/cluster.ts redshift/eventSubscription.ts redshift/getCluster.ts redshift/getServiceAccount.ts redshift/parameterGroup.ts redshift/securityGroup.ts redshift/snapshotCopyGrant.ts redshift/subnetGroup.ts

class Cluster

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.

constructor

new Cluster(name: string, args: ClusterArgs, opts?: pulumi.CustomResourceOptions)

Create a Cluster resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterState): Cluster

Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allowVersionUpgrade

public allowVersionUpgrade: pulumi.Output<boolean | undefined>;

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

property automatedSnapshotRetentionPeriod

public automatedSnapshotRetentionPeriod: pulumi.Output<number | undefined>;

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.

property availabilityZone

public availabilityZone: pulumi.Output<string>;

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.

property bucketName

public bucketName: pulumi.Output<string>;

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 documentation

property clusterIdentifier

public clusterIdentifier: pulumi.Output<string>;

The Cluster Identifier. Must be a lower case string.

property clusterParameterGroupName

public clusterParameterGroupName: pulumi.Output<string>;

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

property clusterPublicKey

public clusterPublicKey: pulumi.Output<string>;

The public key for the cluster

property clusterRevisionNumber

public clusterRevisionNumber: pulumi.Output<string>;

The specific revision number of the database in the cluster

property clusterSecurityGroups

public clusterSecurityGroups: pulumi.Output<string[]>;

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

property clusterSubnetGroupName

public clusterSubnetGroupName: pulumi.Output<string>;

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).

property clusterType

public clusterType: pulumi.Output<string>;

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

property clusterVersion

public clusterVersion: pulumi.Output<string | undefined>;

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.

property databaseName

public databaseName: pulumi.Output<string>;

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.

property dnsName

public dnsName: pulumi.Output<string>;

The DNS name of the cluster

property elasticIp

public elasticIp: pulumi.Output<string | undefined>;

The Elastic IP (EIP) address for the cluster.

property enableLogging

public enableLogging: pulumi.Output<boolean>;

property encrypted

public encrypted: pulumi.Output<boolean>;

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

property endpoint

public endpoint: pulumi.Output<string>;

The connection endpoint

property enhancedVpcRouting

public enhancedVpcRouting: pulumi.Output<boolean>;

If true , enhanced VPC routing is enabled.

property finalSnapshotIdentifier

public finalSnapshotIdentifier: pulumi.Output<string | undefined>;

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.

property iamRoles

public iamRoles: pulumi.Output<string[]>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kmsKeyId

public kmsKeyId: pulumi.Output<string>;

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

property logging

public logging: pulumi.Output<{ ... } | undefined>;

Logging, documented below.

property masterPassword

public masterPassword: pulumi.Output<string | undefined>;

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.

property masterUsername

public masterUsername: pulumi.Output<string | undefined>;

Username for the master DB user.

property nodeType

public nodeType: pulumi.Output<string>;

The node type to be provisioned for the cluster.

property numberOfNodes

public numberOfNodes: pulumi.Output<number | undefined>;

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

property ownerAccount

public ownerAccount: pulumi.Output<string | undefined>;

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.

property port

public port: pulumi.Output<number | undefined>;

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.

property preferredMaintenanceWindow

public preferredMaintenanceWindow: pulumi.Output<string>;

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

property publiclyAccessible

public publiclyAccessible: pulumi.Output<boolean | undefined>;

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

property s3KeyPrefix

public s3KeyPrefix: pulumi.Output<string>;

The prefix applied to the log file names.

property skipFinalSnapshot

public skipFinalSnapshot: pulumi.Output<boolean | undefined>;

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.

property snapshotClusterIdentifier

public snapshotClusterIdentifier: pulumi.Output<string | undefined>;

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

property snapshotCopy

public snapshotCopy: pulumi.Output<{ ... } | undefined>;

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

property snapshotIdentifier

public snapshotIdentifier: pulumi.Output<string | undefined>;

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

property tags

public tags: pulumi.Output<Tags | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcSecurityGroupIds

public vpcSecurityGroupIds: pulumi.Output<string[]>;

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

class EventSubscription

Provides a Redshift event subscription resource.

constructor

new EventSubscription(name: string, args: EventSubscriptionArgs, opts?: pulumi.CustomResourceOptions)

Create a EventSubscription resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EventSubscriptionState): EventSubscription

Get an existing EventSubscription resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property customerAwsId

public customerAwsId: pulumi.Output<string>;

property enabled

public enabled: pulumi.Output<boolean | undefined>;

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

property eventCategories

public eventCategories: pulumi.Output<string[] | undefined>;

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.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the Redshift event subscription.

property severity

public severity: pulumi.Output<string | undefined>;

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

property snsTopicArn

public snsTopicArn: pulumi.Output<string>;

The ARN of the SNS topic to send events to.

property sourceIds

public sourceIds: pulumi.Output<string[] | undefined>;

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.

property sourceType

public sourceType: pulumi.Output<string | undefined>;

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.

property status

public status: pulumi.Output<string>;

property tags

public tags: pulumi.Output<{ ... } | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class ParameterGroup

Provides a Redshift Cluster parameter group resource.

constructor

new ParameterGroup(name: string, args: ParameterGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ParameterGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ParameterGroupState): ParameterGroup

Get an existing ParameterGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string>;

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

property family

public family: pulumi.Output<string>;

The family of the Redshift parameter group.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the Redshift parameter.

property parameters

public parameters: pulumi.Output<{ ... }[] | undefined>;

A list of Redshift parameters to apply.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class SecurityGroup

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

constructor

new SecurityGroup(name: string, args: SecurityGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a SecurityGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SecurityGroupState): SecurityGroup

Get an existing SecurityGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ingress

public ingress: pulumi.Output<{ ... }[]>;

A list of ingress rules.

property name

public name: pulumi.Output<string>;

The name of the Redshift security group.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class SnapshotCopyGrant

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.

constructor

new SnapshotCopyGrant(name: string, args: SnapshotCopyGrantArgs, opts?: pulumi.CustomResourceOptions)

Create a SnapshotCopyGrant resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SnapshotCopyGrantState): SnapshotCopyGrant

Get an existing SnapshotCopyGrant resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kmsKeyId

public kmsKeyId: pulumi.Output<string>;

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.

property snapshotCopyGrantName

public snapshotCopyGrantName: pulumi.Output<string>;

A friendly name for identifying the grant.

property tags

public tags: pulumi.Output<{ ... } | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class SubnetGroup

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.

constructor

new SubnetGroup(name: string, args: SubnetGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a SubnetGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SubnetGroupState): SubnetGroup

Get an existing SubnetGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the Redshift Subnet group.

property subnetIds

public subnetIds: pulumi.Output<string[]>;

An array of VPC subnet IDs.

property tags

public tags: pulumi.Output<Tags | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

function getCluster

getCluster(args: GetClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterResult>

Provides details about a specific redshift cluster.

function getServiceAccount

getServiceAccount(args?: GetServiceAccountArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceAccountResult>

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.

interface ClusterArgs

The set of arguments for constructing a Cluster resource.

property allowVersionUpgrade

allowVersionUpgrade?: pulumi.Input<boolean>;

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

property automatedSnapshotRetentionPeriod

automatedSnapshotRetentionPeriod?: pulumi.Input<number>;

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.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

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.

property bucketName

bucketName?: pulumi.Input<string>;

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 documentation

property clusterIdentifier

clusterIdentifier: pulumi.Input<string>;

The Cluster Identifier. Must be a lower case string.

property clusterParameterGroupName

clusterParameterGroupName?: pulumi.Input<string>;

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

property clusterPublicKey

clusterPublicKey?: pulumi.Input<string>;

The public key for the cluster

property clusterRevisionNumber

clusterRevisionNumber?: pulumi.Input<string>;

The specific revision number of the database in the cluster

property clusterSecurityGroups

clusterSecurityGroups?: pulumi.Input<pulumi.Input<string>[]>;

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

property clusterSubnetGroupName

clusterSubnetGroupName?: pulumi.Input<string>;

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).

property clusterType

clusterType?: pulumi.Input<string>;

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

property clusterVersion

clusterVersion?: pulumi.Input<string>;

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.

property databaseName

databaseName?: pulumi.Input<string>;

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.

property elasticIp

elasticIp?: pulumi.Input<string>;

The Elastic IP (EIP) address for the cluster.

property enableLogging

enableLogging?: pulumi.Input<boolean>;

property encrypted

encrypted?: pulumi.Input<boolean>;

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

property endpoint

endpoint?: pulumi.Input<string>;

The connection endpoint

property enhancedVpcRouting

enhancedVpcRouting?: pulumi.Input<boolean>;

If true , enhanced VPC routing is enabled.

property finalSnapshotIdentifier

finalSnapshotIdentifier?: pulumi.Input<string>;

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.

property iamRoles

iamRoles?: pulumi.Input<pulumi.Input<string>[]>;

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

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

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

property logging

logging?: pulumi.Input<{ ... }>;

Logging, documented below.

property masterPassword

masterPassword?: pulumi.Input<string>;

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.

property masterUsername

masterUsername?: pulumi.Input<string>;

Username for the master DB user.

property nodeType

nodeType: pulumi.Input<string>;

The node type to be provisioned for the cluster.

property numberOfNodes

numberOfNodes?: pulumi.Input<number>;

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

property ownerAccount

ownerAccount?: pulumi.Input<string>;

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.

property port

port?: pulumi.Input<number>;

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.

property preferredMaintenanceWindow

preferredMaintenanceWindow?: pulumi.Input<string>;

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

property publiclyAccessible

publiclyAccessible?: pulumi.Input<boolean>;

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

property s3KeyPrefix

s3KeyPrefix?: pulumi.Input<string>;

The prefix applied to the log file names.

property skipFinalSnapshot

skipFinalSnapshot?: pulumi.Input<boolean>;

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.

property snapshotClusterIdentifier

snapshotClusterIdentifier?: pulumi.Input<string>;

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

property snapshotCopy

snapshotCopy?: pulumi.Input<{ ... }>;

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

property snapshotIdentifier

snapshotIdentifier?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

property vpcSecurityGroupIds

vpcSecurityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

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

interface ClusterState

Input properties used for looking up and filtering Cluster resources.

property allowVersionUpgrade

allowVersionUpgrade?: pulumi.Input<boolean>;

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

property automatedSnapshotRetentionPeriod

automatedSnapshotRetentionPeriod?: pulumi.Input<number>;

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.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

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.

property bucketName

bucketName?: pulumi.Input<string>;

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 documentation

property clusterIdentifier

clusterIdentifier?: pulumi.Input<string>;

The Cluster Identifier. Must be a lower case string.

property clusterParameterGroupName

clusterParameterGroupName?: pulumi.Input<string>;

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

property clusterPublicKey

clusterPublicKey?: pulumi.Input<string>;

The public key for the cluster

property clusterRevisionNumber

clusterRevisionNumber?: pulumi.Input<string>;

The specific revision number of the database in the cluster

property clusterSecurityGroups

clusterSecurityGroups?: pulumi.Input<pulumi.Input<string>[]>;

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

property clusterSubnetGroupName

clusterSubnetGroupName?: pulumi.Input<string>;

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).

property clusterType

clusterType?: pulumi.Input<string>;

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

property clusterVersion

clusterVersion?: pulumi.Input<string>;

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.

property databaseName

databaseName?: pulumi.Input<string>;

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.

property dnsName

dnsName?: pulumi.Input<string>;

The DNS name of the cluster

property elasticIp

elasticIp?: pulumi.Input<string>;

The Elastic IP (EIP) address for the cluster.

property enableLogging

enableLogging?: pulumi.Input<boolean>;

property encrypted

encrypted?: pulumi.Input<boolean>;

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

property endpoint

endpoint?: pulumi.Input<string>;

The connection endpoint

property enhancedVpcRouting

enhancedVpcRouting?: pulumi.Input<boolean>;

If true , enhanced VPC routing is enabled.

property finalSnapshotIdentifier

finalSnapshotIdentifier?: pulumi.Input<string>;

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.

property iamRoles

iamRoles?: pulumi.Input<pulumi.Input<string>[]>;

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

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

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

property logging

logging?: pulumi.Input<{ ... }>;

Logging, documented below.

property masterPassword

masterPassword?: pulumi.Input<string>;

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.

property masterUsername

masterUsername?: pulumi.Input<string>;

Username for the master DB user.

property nodeType

nodeType?: pulumi.Input<string>;

The node type to be provisioned for the cluster.

property numberOfNodes

numberOfNodes?: pulumi.Input<number>;

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

property ownerAccount

ownerAccount?: pulumi.Input<string>;

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.

property port

port?: pulumi.Input<number>;

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.

property preferredMaintenanceWindow

preferredMaintenanceWindow?: pulumi.Input<string>;

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

property publiclyAccessible

publiclyAccessible?: pulumi.Input<boolean>;

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

property s3KeyPrefix

s3KeyPrefix?: pulumi.Input<string>;

The prefix applied to the log file names.

property skipFinalSnapshot

skipFinalSnapshot?: pulumi.Input<boolean>;

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.

property snapshotClusterIdentifier

snapshotClusterIdentifier?: pulumi.Input<string>;

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

property snapshotCopy

snapshotCopy?: pulumi.Input<{ ... }>;

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

property snapshotIdentifier

snapshotIdentifier?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

property vpcSecurityGroupIds

vpcSecurityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

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

interface EventSubscriptionArgs

The set of arguments for constructing a EventSubscription resource.

property enabled

enabled?: pulumi.Input<boolean>;

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

property eventCategories

eventCategories?: pulumi.Input<pulumi.Input<string>[]>;

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.

property name

name?: pulumi.Input<string>;

The name of the Redshift event subscription.

property severity

severity?: pulumi.Input<string>;

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

property snsTopicArn

snsTopicArn: pulumi.Input<string>;

The ARN of the SNS topic to send events to.

property sourceIds

sourceIds?: pulumi.Input<pulumi.Input<string>[]>;

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.

property sourceType

sourceType?: pulumi.Input<string>;

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.

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

interface EventSubscriptionState

Input properties used for looking up and filtering EventSubscription resources.

property customerAwsId

customerAwsId?: pulumi.Input<string>;

property enabled

enabled?: pulumi.Input<boolean>;

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

property eventCategories

eventCategories?: pulumi.Input<pulumi.Input<string>[]>;

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.

property name

name?: pulumi.Input<string>;

The name of the Redshift event subscription.

property severity

severity?: pulumi.Input<string>;

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

property snsTopicArn

snsTopicArn?: pulumi.Input<string>;

The ARN of the SNS topic to send events to.

property sourceIds

sourceIds?: pulumi.Input<pulumi.Input<string>[]>;

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.

property sourceType

sourceType?: pulumi.Input<string>;

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.

property status

status?: pulumi.Input<string>;

property tags

tags?: pulumi.Input<{ ... }>;

A mapping of tags to assign to the resource.

interface GetClusterArgs

A collection of arguments for invoking getCluster.

property clusterIdentifier

clusterIdentifier: string;

The cluster identifier

property tags

tags?: { ... };

interface GetClusterResult

A collection of values returned by getCluster.

property allowVersionUpgrade

allowVersionUpgrade: boolean;

Whether major version upgrades can be applied during maintenance period

property automatedSnapshotRetentionPeriod

automatedSnapshotRetentionPeriod: number;

The backup retention period

property availabilityZone

availabilityZone: string;

The availability zone of the cluster

property bucketName

bucketName: string;

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

property clusterParameterGroupName

clusterParameterGroupName: string;

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

property clusterPublicKey

clusterPublicKey: string;

The public key for the cluster

property clusterRevisionNumber

clusterRevisionNumber: string;

The cluster revision number

property clusterSecurityGroups

clusterSecurityGroups: string[];

The security groups associated with the cluster

property clusterSubnetGroupName

clusterSubnetGroupName: string;

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

property clusterType

clusterType: string;

The cluster type

property clusterVersion

clusterVersion: string;

property databaseName

databaseName: string;

The name of the default database in the cluster

property elasticIp

elasticIp: string;

The Elastic IP of the cluster

property enableLogging

enableLogging: boolean;

Whether cluster logging is enabled

property encrypted

encrypted: boolean;

Whether the cluster data is encrypted

property endpoint

endpoint: string;

The cluster endpoint

property enhancedVpcRouting

enhancedVpcRouting: boolean;

Whether enhanced VPC routing is enabled

property iamRoles

iamRoles: string[];

The IAM roles associated to the cluster

property id

id: string;

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

property kmsKeyId

kmsKeyId: string;

The KMS encryption key associated to the cluster

property masterUsername

masterUsername: string;

Username for the master DB user

property nodeType

nodeType: string;

The cluster node type

property numberOfNodes

numberOfNodes: number;

The number of nodes in the cluster

property port

port: number;

The port the cluster responds on

property preferredMaintenanceWindow

preferredMaintenanceWindow: string;

The maintenance window

property publiclyAccessible

publiclyAccessible: boolean;

Whether the cluster is publicly accessible

property s3KeyPrefix

s3KeyPrefix: string;

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

property vpcId

vpcId: string;

The VPC Id associated with the cluster

property vpcSecurityGroupIds

vpcSecurityGroupIds: string[];

The VPC security group Ids associated with the cluster

interface GetServiceAccountArgs

A collection of arguments for invoking getServiceAccount.

property region

region?: string;

Name of the region whose AWS Redshift account ID is desired. Defaults to the region from the AWS provider configuration.

interface GetServiceAccountResult

A collection of values returned by getServiceAccount.

property arn

arn: string;

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

property id

id: string;

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

interface ParameterGroupArgs

The set of arguments for constructing a ParameterGroup resource.

property description

description?: pulumi.Input<string>;

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

property family

family: pulumi.Input<string>;

The family of the Redshift parameter group.

property name

name?: pulumi.Input<string>;

The name of the Redshift parameter.

property parameters

parameters?: pulumi.Input<pulumi.Input<{ ... }>[]>;

A list of Redshift parameters to apply.

interface ParameterGroupState

Input properties used for looking up and filtering ParameterGroup resources.

property description

description?: pulumi.Input<string>;

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

property family

family?: pulumi.Input<string>;

The family of the Redshift parameter group.

property name

name?: pulumi.Input<string>;

The name of the Redshift parameter.

property parameters

parameters?: pulumi.Input<pulumi.Input<{ ... }>[]>;

A list of Redshift parameters to apply.

interface SecurityGroupArgs

The set of arguments for constructing a SecurityGroup resource.

property description

description?: pulumi.Input<string>;

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

property ingress

ingress: pulumi.Input<pulumi.Input<{ ... }>[]>;

A list of ingress rules.

property name

name?: pulumi.Input<string>;

The name of the Redshift security group.

interface SecurityGroupState

Input properties used for looking up and filtering SecurityGroup resources.

property description

description?: pulumi.Input<string>;

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

property ingress

ingress?: pulumi.Input<pulumi.Input<{ ... }>[]>;

A list of ingress rules.

property name

name?: pulumi.Input<string>;

The name of the Redshift security group.

interface SnapshotCopyGrantArgs

The set of arguments for constructing a SnapshotCopyGrant resource.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

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.

property snapshotCopyGrantName

snapshotCopyGrantName: pulumi.Input<string>;

A friendly name for identifying the grant.

property tags

tags?: pulumi.Input<{ ... }>;

interface SnapshotCopyGrantState

Input properties used for looking up and filtering SnapshotCopyGrant resources.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

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.

property snapshotCopyGrantName

snapshotCopyGrantName?: pulumi.Input<string>;

A friendly name for identifying the grant.

property tags

tags?: pulumi.Input<{ ... }>;

interface SubnetGroupArgs

The set of arguments for constructing a SubnetGroup resource.

property description

description?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

The name of the Redshift Subnet group.

property subnetIds

subnetIds: pulumi.Input<pulumi.Input<string>[]>;

An array of VPC subnet IDs.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

interface SubnetGroupState

Input properties used for looking up and filtering SubnetGroup resources.

property description

description?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

The name of the Redshift Subnet group.

property subnetIds

subnetIds?: pulumi.Input<pulumi.Input<string>[]>;

An array of VPC subnet IDs.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.