|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title: "redshift_datashare Resource - terraform-provider-redshift" |
| 4 | +subcategory: "" |
| 5 | +description: |- |
| 6 | + Defines a Redshift datashare. Datashares allows a Redshift cluster (the "consumer") to |
| 7 | + read data stored in another Redshift cluster (the "producer"). For more information, see |
| 8 | + https://docs.aws.amazon.com/redshift/latest/dg/datashare-overview.html |
| 9 | + The redshift_datashare resource should be defined on the producer cluster. |
| 10 | + Note: Data sharing is only supported on certain Redshift instance families, |
| 11 | + such as RA3. |
| 12 | +--- |
| 13 | + |
| 14 | +# redshift_datashare (Resource) |
| 15 | + |
| 16 | +Defines a Redshift datashare. Datashares allows a Redshift cluster (the "consumer") to |
| 17 | +read data stored in another Redshift cluster (the "producer"). For more information, see |
| 18 | +https://docs.aws.amazon.com/redshift/latest/dg/datashare-overview.html |
| 19 | + |
| 20 | +The redshift_datashare resource should be defined on the producer cluster. |
| 21 | + |
| 22 | +Note: Data sharing is only supported on certain Redshift instance families, |
| 23 | +such as RA3. |
| 24 | + |
| 25 | +## Example Usage |
| 26 | + |
| 27 | +```terraform |
| 28 | +resource "redshift_datashare" "my_datashare" { |
| 29 | + name = "my_datashare" # Required |
| 30 | + owner = "my_user" # Optional. |
| 31 | + publicly_accessible = false # Optional. Default is `false`. |
| 32 | +
|
| 33 | + # Optional. Specifies which schemas to expose to the datashare. |
| 34 | + schemas = [ |
| 35 | + "public", |
| 36 | + "other", |
| 37 | + ] |
| 38 | +} |
| 39 | +``` |
| 40 | + |
| 41 | +<!-- schema generated by tfplugindocs --> |
| 42 | +## Schema |
| 43 | + |
| 44 | +### Required |
| 45 | + |
| 46 | +- **name** (String) The name of the datashare. |
| 47 | + |
| 48 | +### Optional |
| 49 | + |
| 50 | +- **id** (String) The ID of this resource. |
| 51 | +- **owner** (String) The user who owns the datashare. |
| 52 | +- **publicly_accessible** (Boolean) Specifies whether the datashare can be shared to clusters that are publicly accessible. Default is `false`. |
| 53 | +- **schemas** (Set of String) Defines which schemas are exposed to the data share. |
| 54 | + |
| 55 | +### Read-Only |
| 56 | + |
| 57 | +- **created** (String) The date when datashare was created |
| 58 | +- **producer_account** (String) The ID for the datashare producer account. |
| 59 | +- **producer_namespace** (String) The unique cluster identifier for the datashare producer cluster. |
| 60 | + |
| 61 | + |
0 commit comments