@aws-cdk/aws-redshift-alpha 2.1.0-alpha.0 → 2.5.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.jsii CHANGED
@@ -8,7 +8,7 @@
8
8
  "url": "https://aws.amazon.com"
9
9
  },
10
10
  "dependencies": {
11
- "aws-cdk-lib": "^2.1.0",
11
+ "aws-cdk-lib": "^2.5.0",
12
12
  "constructs": "^10.0.0"
13
13
  },
14
14
  "dependencyClosure": {
@@ -105,6 +105,19 @@
105
105
  }
106
106
  }
107
107
  },
108
+ "aws-cdk-lib.aws_amplifyuibuilder": {
109
+ "targets": {
110
+ "dotnet": {
111
+ "namespace": "Amazon.CDK.AWS.AmplifyUIBuilder"
112
+ },
113
+ "java": {
114
+ "package": "software.amazon.awscdk.services.amplifyuibuilder"
115
+ },
116
+ "python": {
117
+ "module": "aws_cdk.aws_amplifyuibuilder"
118
+ }
119
+ }
120
+ },
108
121
  "aws-cdk-lib.aws_apigateway": {
109
122
  "targets": {
110
123
  "dotnet": {
@@ -1120,6 +1133,19 @@
1120
1133
  }
1121
1134
  }
1122
1135
  },
1136
+ "aws-cdk-lib.aws_evidently": {
1137
+ "targets": {
1138
+ "dotnet": {
1139
+ "namespace": "Amazon.CDK.AWS.Evidently"
1140
+ },
1141
+ "java": {
1142
+ "package": "software.amazon.awscdk.services.evidently"
1143
+ },
1144
+ "python": {
1145
+ "module": "aws_cdk.aws_evidently"
1146
+ }
1147
+ }
1148
+ },
1123
1149
  "aws-cdk-lib.aws_finspace": {
1124
1150
  "targets": {
1125
1151
  "dotnet": {
@@ -1601,6 +1627,19 @@
1601
1627
  }
1602
1628
  }
1603
1629
  },
1630
+ "aws-cdk-lib.aws_lex": {
1631
+ "targets": {
1632
+ "dotnet": {
1633
+ "namespace": "Amazon.CDK.AWS.Lex"
1634
+ },
1635
+ "java": {
1636
+ "package": "software.amazon.awscdk.services.lex"
1637
+ },
1638
+ "python": {
1639
+ "module": "aws_cdk.aws_lex"
1640
+ }
1641
+ }
1642
+ },
1604
1643
  "aws-cdk-lib.aws_licensemanager": {
1605
1644
  "targets": {
1606
1645
  "dotnet": {
@@ -2030,6 +2069,19 @@
2030
2069
  }
2031
2070
  }
2032
2071
  },
2072
+ "aws-cdk-lib.aws_refactorspaces": {
2073
+ "targets": {
2074
+ "dotnet": {
2075
+ "namespace": "Amazon.CDK.AWS.RefactorSpaces"
2076
+ },
2077
+ "java": {
2078
+ "package": "software.amazon.awscdk.services.refactorspaces"
2079
+ },
2080
+ "python": {
2081
+ "module": "aws_cdk.aws_refactorspaces"
2082
+ }
2083
+ }
2084
+ },
2033
2085
  "aws-cdk-lib.aws_rekognition": {
2034
2086
  "targets": {
2035
2087
  "dotnet": {
@@ -2043,6 +2095,19 @@
2043
2095
  }
2044
2096
  }
2045
2097
  },
2098
+ "aws-cdk-lib.aws_resiliencehub": {
2099
+ "targets": {
2100
+ "dotnet": {
2101
+ "namespace": "Amazon.CDK.AWS.ResilienceHub"
2102
+ },
2103
+ "java": {
2104
+ "package": "software.amazon.awscdk.services.resiliencehub"
2105
+ },
2106
+ "python": {
2107
+ "module": "aws_cdk.aws_resiliencehub"
2108
+ }
2109
+ }
2110
+ },
2046
2111
  "aws-cdk-lib.aws_resourcegroups": {
2047
2112
  "targets": {
2048
2113
  "dotnet": {
@@ -2147,6 +2212,19 @@
2147
2212
  }
2148
2213
  }
2149
2214
  },
2215
+ "aws-cdk-lib.aws_rum": {
2216
+ "targets": {
2217
+ "dotnet": {
2218
+ "namespace": "Amazon.CDK.AWS.RUM"
2219
+ },
2220
+ "java": {
2221
+ "package": "software.amazon.awscdk.services.rum"
2222
+ },
2223
+ "python": {
2224
+ "module": "aws_cdk.aws_rum"
2225
+ }
2226
+ }
2227
+ },
2150
2228
  "aws-cdk-lib.aws_s3": {
2151
2229
  "targets": {
2152
2230
  "dotnet": {
@@ -2777,7 +2855,7 @@
2777
2855
  "stability": "experimental"
2778
2856
  },
2779
2857
  "homepage": "https://github.com/aws/aws-cdk",
2780
- "jsiiVersion": "1.46.0 (build cd08c55)",
2858
+ "jsiiVersion": "1.50.0 (build d1830a4)",
2781
2859
  "keywords": [
2782
2860
  "aws",
2783
2861
  "cdk",
@@ -2841,6 +2919,7 @@
2841
2919
  "base": "aws-cdk-lib.Resource",
2842
2920
  "docs": {
2843
2921
  "custom": {
2922
+ "exampleMetadata": "infused",
2844
2923
  "resource": "AWS::Redshift::Cluster"
2845
2924
  },
2846
2925
  "example": "import * as ec2 from 'aws-cdk-lib/aws-ec2';\n\nconst vpc = new ec2.Vpc(this, 'Vpc');\nconst cluster = new Cluster(this, 'Redshift', {\n masterUser: {\n masterUsername: 'admin',\n },\n vpc\n});",
@@ -3074,7 +3153,7 @@
3074
3153
  "docs": {
3075
3154
  "stability": "experimental",
3076
3155
  "summary": "Properties that describe an existing cluster instance.",
3077
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\nimport { aws_ec2 as ec2 } from 'aws-cdk-lib';\n\ndeclare const securityGroup: ec2.SecurityGroup;\n\nconst clusterAttributes: redshift_alpha.ClusterAttributes = {\n clusterEndpointAddress: 'clusterEndpointAddress',\n clusterEndpointPort: 123,\n clusterName: 'clusterName',\n\n // the properties below are optional\n securityGroups: [securityGroup],\n};",
3156
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\nimport { aws_ec2 as ec2 } from 'aws-cdk-lib';\n\ndeclare const securityGroup: ec2.SecurityGroup;\nconst clusterAttributes: redshift_alpha.ClusterAttributes = {\n clusterEndpointAddress: 'clusterEndpointAddress',\n clusterEndpointPort: 123,\n clusterName: 'clusterName',\n\n // the properties below are optional\n securityGroups: [securityGroup],\n};",
3078
3157
  "custom": {
3079
3158
  "exampleMetadata": "fixture=_generated"
3080
3159
  }
@@ -3171,7 +3250,7 @@
3171
3250
  },
3172
3251
  "stability": "experimental",
3173
3252
  "summary": "A cluster parameter group.",
3174
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\n\nconst clusterParameterGroup = new redshift_alpha.ClusterParameterGroup(this, 'MyClusterParameterGroup', {\n parameters: {\n parametersKey: 'parameters',\n },\n\n // the properties below are optional\n description: 'description',\n});"
3253
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\nconst clusterParameterGroup = new redshift_alpha.ClusterParameterGroup(this, 'MyClusterParameterGroup', {\n parameters: {\n parametersKey: 'parameters',\n },\n\n // the properties below are optional\n description: 'description',\n});"
3175
3254
  },
3176
3255
  "fqn": "@aws-cdk/aws-redshift-alpha.ClusterParameterGroup",
3177
3256
  "initializer": {
@@ -3277,7 +3356,7 @@
3277
3356
  "docs": {
3278
3357
  "stability": "experimental",
3279
3358
  "summary": "Properties for a parameter group.",
3280
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\n\nconst clusterParameterGroupProps: redshift_alpha.ClusterParameterGroupProps = {\n parameters: {\n parametersKey: 'parameters',\n },\n\n // the properties below are optional\n description: 'description',\n};",
3359
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\nconst clusterParameterGroupProps: redshift_alpha.ClusterParameterGroupProps = {\n parameters: {\n parametersKey: 'parameters',\n },\n\n // the properties below are optional\n description: 'description',\n};",
3281
3360
  "custom": {
3282
3361
  "exampleMetadata": "fixture=_generated"
3283
3362
  }
@@ -3293,40 +3372,40 @@
3293
3372
  {
3294
3373
  "abstract": true,
3295
3374
  "docs": {
3296
- "default": "a CDK generated description",
3297
3375
  "stability": "experimental",
3298
- "summary": "Description for this parameter group."
3376
+ "summary": "The parameters in this parameter group."
3299
3377
  },
3300
3378
  "immutable": true,
3301
3379
  "locationInModule": {
3302
3380
  "filename": "lib/parameter-group.ts",
3303
- "line": 36
3381
+ "line": 41
3304
3382
  },
3305
- "name": "description",
3306
- "optional": true,
3383
+ "name": "parameters",
3307
3384
  "type": {
3308
- "primitive": "string"
3385
+ "collection": {
3386
+ "elementtype": {
3387
+ "primitive": "string"
3388
+ },
3389
+ "kind": "map"
3390
+ }
3309
3391
  }
3310
3392
  },
3311
3393
  {
3312
3394
  "abstract": true,
3313
3395
  "docs": {
3396
+ "default": "a CDK generated description",
3314
3397
  "stability": "experimental",
3315
- "summary": "The parameters in this parameter group."
3398
+ "summary": "Description for this parameter group."
3316
3399
  },
3317
3400
  "immutable": true,
3318
3401
  "locationInModule": {
3319
3402
  "filename": "lib/parameter-group.ts",
3320
- "line": 41
3403
+ "line": 36
3321
3404
  },
3322
- "name": "parameters",
3405
+ "name": "description",
3406
+ "optional": true,
3323
3407
  "type": {
3324
- "collection": {
3325
- "elementtype": {
3326
- "primitive": "string"
3327
- },
3328
- "kind": "map"
3329
- }
3408
+ "primitive": "string"
3330
3409
  }
3331
3410
  }
3332
3411
  ],
@@ -3336,6 +3415,9 @@
3336
3415
  "assembly": "@aws-cdk/aws-redshift-alpha",
3337
3416
  "datatype": true,
3338
3417
  "docs": {
3418
+ "custom": {
3419
+ "exampleMetadata": "infused"
3420
+ },
3339
3421
  "example": "import * as ec2 from 'aws-cdk-lib/aws-ec2';\n\nconst vpc = new ec2.Vpc(this, 'Vpc');\nconst cluster = new Cluster(this, 'Redshift', {\n masterUser: {\n masterUsername: 'admin',\n },\n vpc\n});",
3340
3422
  "stability": "experimental",
3341
3423
  "summary": "Properties for a new database cluster."
@@ -3732,7 +3814,7 @@
3732
3814
  },
3733
3815
  "stability": "experimental",
3734
3816
  "summary": "Class for creating a Redshift cluster subnet group.",
3735
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\nimport * as cdk from 'aws-cdk-lib';\nimport { aws_ec2 as ec2 } from 'aws-cdk-lib';\n\ndeclare const subnet: ec2.Subnet;\ndeclare const subnetFilter: ec2.SubnetFilter;\ndeclare const vpc: ec2.Vpc;\n\nconst clusterSubnetGroup = new redshift_alpha.ClusterSubnetGroup(this, 'MyClusterSubnetGroup', {\n description: 'description',\n vpc: vpc,\n\n // the properties below are optional\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n vpcSubnets: {\n availabilityZones: ['availabilityZones'],\n onePerAz: false,\n subnetFilters: [subnetFilter],\n subnetGroupName: 'subnetGroupName',\n subnets: [subnet],\n subnetType: ec2.SubnetType.PRIVATE_ISOLATED,\n },\n});"
3817
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\nimport * as cdk from 'aws-cdk-lib';\nimport { aws_ec2 as ec2 } from 'aws-cdk-lib';\n\ndeclare const subnet: ec2.Subnet;\ndeclare const subnetFilter: ec2.SubnetFilter;\ndeclare const vpc: ec2.Vpc;\nconst clusterSubnetGroup = new redshift_alpha.ClusterSubnetGroup(this, 'MyClusterSubnetGroup', {\n description: 'description',\n vpc: vpc,\n\n // the properties below are optional\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n vpcSubnets: {\n availabilityZones: ['availabilityZones'],\n onePerAz: false,\n subnetFilters: [subnetFilter],\n subnetGroupName: 'subnetGroupName',\n subnets: [subnet],\n subnetType: ec2.SubnetType.PRIVATE_ISOLATED,\n },\n});"
3736
3818
  },
3737
3819
  "fqn": "@aws-cdk/aws-redshift-alpha.ClusterSubnetGroup",
3738
3820
  "initializer": {
@@ -3838,7 +3920,7 @@
3838
3920
  "docs": {
3839
3921
  "stability": "experimental",
3840
3922
  "summary": "Properties for creating a ClusterSubnetGroup.",
3841
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\nimport * as cdk from 'aws-cdk-lib';\nimport { aws_ec2 as ec2 } from 'aws-cdk-lib';\n\ndeclare const subnet: ec2.Subnet;\ndeclare const subnetFilter: ec2.SubnetFilter;\ndeclare const vpc: ec2.Vpc;\n\nconst clusterSubnetGroupProps: redshift_alpha.ClusterSubnetGroupProps = {\n description: 'description',\n vpc: vpc,\n\n // the properties below are optional\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n vpcSubnets: {\n availabilityZones: ['availabilityZones'],\n onePerAz: false,\n subnetFilters: [subnetFilter],\n subnetGroupName: 'subnetGroupName',\n subnets: [subnet],\n subnetType: ec2.SubnetType.PRIVATE_ISOLATED,\n },\n};",
3923
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\nimport * as cdk from 'aws-cdk-lib';\nimport { aws_ec2 as ec2 } from 'aws-cdk-lib';\n\ndeclare const subnet: ec2.Subnet;\ndeclare const subnetFilter: ec2.SubnetFilter;\ndeclare const vpc: ec2.Vpc;\nconst clusterSubnetGroupProps: redshift_alpha.ClusterSubnetGroupProps = {\n description: 'description',\n vpc: vpc,\n\n // the properties below are optional\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n vpcSubnets: {\n availabilityZones: ['availabilityZones'],\n onePerAz: false,\n subnetFilters: [subnetFilter],\n subnetGroupName: 'subnetGroupName',\n subnets: [subnet],\n subnetType: ec2.SubnetType.PRIVATE_ISOLATED,\n },\n};",
3842
3924
  "custom": {
3843
3925
  "exampleMetadata": "fixture=_generated"
3844
3926
  }
@@ -3870,35 +3952,35 @@
3870
3952
  {
3871
3953
  "abstract": true,
3872
3954
  "docs": {
3873
- "default": "RemovalPolicy.RETAIN",
3874
3955
  "stability": "experimental",
3875
- "summary": "The removal policy to apply when the subnet group are removed from the stack or replaced during an update."
3956
+ "summary": "The VPC to place the subnet group in."
3876
3957
  },
3877
3958
  "immutable": true,
3878
3959
  "locationInModule": {
3879
3960
  "filename": "lib/subnet-group.ts",
3880
- "line": 44
3961
+ "line": 29
3881
3962
  },
3882
- "name": "removalPolicy",
3883
- "optional": true,
3963
+ "name": "vpc",
3884
3964
  "type": {
3885
- "fqn": "aws-cdk-lib.RemovalPolicy"
3965
+ "fqn": "aws-cdk-lib.aws_ec2.IVpc"
3886
3966
  }
3887
3967
  },
3888
3968
  {
3889
3969
  "abstract": true,
3890
3970
  "docs": {
3971
+ "default": "RemovalPolicy.RETAIN",
3891
3972
  "stability": "experimental",
3892
- "summary": "The VPC to place the subnet group in."
3973
+ "summary": "The removal policy to apply when the subnet group are removed from the stack or replaced during an update."
3893
3974
  },
3894
3975
  "immutable": true,
3895
3976
  "locationInModule": {
3896
3977
  "filename": "lib/subnet-group.ts",
3897
- "line": 29
3978
+ "line": 44
3898
3979
  },
3899
- "name": "vpc",
3980
+ "name": "removalPolicy",
3981
+ "optional": true,
3900
3982
  "type": {
3901
- "fqn": "aws-cdk-lib.aws_ec2.IVpc"
3983
+ "fqn": "aws-cdk-lib.RemovalPolicy"
3902
3984
  }
3903
3985
  },
3904
3986
  {
@@ -3960,7 +4042,7 @@
3960
4042
  "docs": {
3961
4043
  "stability": "experimental",
3962
4044
  "summary": "A column in a Redshift table.",
3963
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\n\nconst column: redshift_alpha.Column = {\n dataType: 'dataType',\n name: 'name',\n\n // the properties below are optional\n distKey: false,\n sortKey: false,\n};",
4045
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\nconst column: redshift_alpha.Column = {\n dataType: 'dataType',\n name: 'name',\n\n // the properties below are optional\n distKey: false,\n sortKey: false,\n};",
3964
4046
  "custom": {
3965
4047
  "exampleMetadata": "fixture=_generated"
3966
4048
  }
@@ -3992,35 +4074,35 @@
3992
4074
  {
3993
4075
  "abstract": true,
3994
4076
  "docs": {
3995
- "default": "- column is not DISTKEY",
3996
4077
  "stability": "experimental",
3997
- "summary": "Boolean value that indicates whether the column is to be configured as DISTKEY."
4078
+ "summary": "The name of the column."
3998
4079
  },
3999
4080
  "immutable": true,
4000
4081
  "locationInModule": {
4001
4082
  "filename": "lib/table.ts",
4002
- "line": 75
4083
+ "line": 63
4003
4084
  },
4004
- "name": "distKey",
4005
- "optional": true,
4085
+ "name": "name",
4006
4086
  "type": {
4007
- "primitive": "boolean"
4087
+ "primitive": "string"
4008
4088
  }
4009
4089
  },
4010
4090
  {
4011
4091
  "abstract": true,
4012
4092
  "docs": {
4093
+ "default": "- column is not DISTKEY",
4013
4094
  "stability": "experimental",
4014
- "summary": "The name of the column."
4095
+ "summary": "Boolean value that indicates whether the column is to be configured as DISTKEY."
4015
4096
  },
4016
4097
  "immutable": true,
4017
4098
  "locationInModule": {
4018
4099
  "filename": "lib/table.ts",
4019
- "line": 63
4100
+ "line": 75
4020
4101
  },
4021
- "name": "name",
4102
+ "name": "distKey",
4103
+ "optional": true,
4022
4104
  "type": {
4023
- "primitive": "string"
4105
+ "primitive": "boolean"
4024
4106
  }
4025
4107
  },
4026
4108
  {
@@ -4050,7 +4132,7 @@
4050
4132
  "docs": {
4051
4133
  "stability": "experimental",
4052
4134
  "summary": "Properties for accessing a Redshift database.",
4053
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\nimport { aws_secretsmanager as secretsmanager } from 'aws-cdk-lib';\n\ndeclare const cluster: redshift_alpha.Cluster;\ndeclare const secret: secretsmanager.Secret;\n\nconst databaseOptions: redshift_alpha.DatabaseOptions = {\n cluster: cluster,\n databaseName: 'databaseName',\n\n // the properties below are optional\n adminUser: secret,\n};",
4135
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\nimport { aws_secretsmanager as secretsmanager } from 'aws-cdk-lib';\n\ndeclare const cluster: redshift_alpha.Cluster;\ndeclare const secret: secretsmanager.Secret;\nconst databaseOptions: redshift_alpha.DatabaseOptions = {\n cluster: cluster,\n databaseName: 'databaseName',\n\n // the properties below are optional\n adminUser: secret,\n};",
4054
4136
  "custom": {
4055
4137
  "exampleMetadata": "fixture=_generated"
4056
4138
  }
@@ -4066,52 +4148,52 @@
4066
4148
  {
4067
4149
  "abstract": true,
4068
4150
  "docs": {
4069
- "default": "- the admin secret is taken from the cluster",
4070
- "remarks": "Secret JSON schema: `{ username: string; password: string }`.",
4071
4151
  "stability": "experimental",
4072
- "summary": "The secret containing credentials to a Redshift user with administrator privileges."
4152
+ "summary": "The cluster containing the database."
4073
4153
  },
4074
4154
  "immutable": true,
4075
4155
  "locationInModule": {
4076
4156
  "filename": "lib/database-options.ts",
4077
- "line": 25
4157
+ "line": 11
4078
4158
  },
4079
- "name": "adminUser",
4080
- "optional": true,
4159
+ "name": "cluster",
4081
4160
  "type": {
4082
- "fqn": "aws-cdk-lib.aws_secretsmanager.ISecret"
4161
+ "fqn": "@aws-cdk/aws-redshift-alpha.ICluster"
4083
4162
  }
4084
4163
  },
4085
4164
  {
4086
4165
  "abstract": true,
4087
4166
  "docs": {
4088
4167
  "stability": "experimental",
4089
- "summary": "The cluster containing the database."
4168
+ "summary": "The name of the database."
4090
4169
  },
4091
4170
  "immutable": true,
4092
4171
  "locationInModule": {
4093
4172
  "filename": "lib/database-options.ts",
4094
- "line": 11
4173
+ "line": 16
4095
4174
  },
4096
- "name": "cluster",
4175
+ "name": "databaseName",
4097
4176
  "type": {
4098
- "fqn": "@aws-cdk/aws-redshift-alpha.ICluster"
4177
+ "primitive": "string"
4099
4178
  }
4100
4179
  },
4101
4180
  {
4102
4181
  "abstract": true,
4103
4182
  "docs": {
4183
+ "default": "- the admin secret is taken from the cluster",
4184
+ "remarks": "Secret JSON schema: `{ username: string; password: string }`.",
4104
4185
  "stability": "experimental",
4105
- "summary": "The name of the database."
4186
+ "summary": "The secret containing credentials to a Redshift user with administrator privileges."
4106
4187
  },
4107
4188
  "immutable": true,
4108
4189
  "locationInModule": {
4109
4190
  "filename": "lib/database-options.ts",
4110
- "line": 16
4191
+ "line": 25
4111
4192
  },
4112
- "name": "databaseName",
4193
+ "name": "adminUser",
4194
+ "optional": true,
4113
4195
  "type": {
4114
- "primitive": "string"
4196
+ "fqn": "aws-cdk-lib.aws_secretsmanager.ISecret"
4115
4197
  }
4116
4198
  }
4117
4199
  ],
@@ -4127,7 +4209,7 @@
4127
4209
  },
4128
4210
  "stability": "experimental",
4129
4211
  "summary": "A database secret.",
4130
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\nimport { aws_kms as kms } from 'aws-cdk-lib';\n\ndeclare const key: kms.Key;\n\nconst databaseSecret = new redshift_alpha.DatabaseSecret(this, 'MyDatabaseSecret', {\n username: 'username',\n\n // the properties below are optional\n encryptionKey: key,\n});"
4212
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\nimport { aws_kms as kms } from 'aws-cdk-lib';\n\ndeclare const key: kms.Key;\nconst databaseSecret = new redshift_alpha.DatabaseSecret(this, 'MyDatabaseSecret', {\n username: 'username',\n\n // the properties below are optional\n encryptionKey: key,\n});"
4131
4213
  },
4132
4214
  "fqn": "@aws-cdk/aws-redshift-alpha.DatabaseSecret",
4133
4215
  "initializer": {
@@ -4173,7 +4255,7 @@
4173
4255
  "docs": {
4174
4256
  "stability": "experimental",
4175
4257
  "summary": "Construction properties for a DatabaseSecret.",
4176
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\nimport { aws_kms as kms } from 'aws-cdk-lib';\n\ndeclare const key: kms.Key;\n\nconst databaseSecretProps: redshift_alpha.DatabaseSecretProps = {\n username: 'username',\n\n // the properties below are optional\n encryptionKey: key,\n};",
4258
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\nimport { aws_kms as kms } from 'aws-cdk-lib';\n\ndeclare const key: kms.Key;\nconst databaseSecretProps: redshift_alpha.DatabaseSecretProps = {\n username: 'username',\n\n // the properties below are optional\n encryptionKey: key,\n};",
4177
4259
  "custom": {
4178
4260
  "exampleMetadata": "fixture=_generated"
4179
4261
  }
@@ -4189,35 +4271,35 @@
4189
4271
  {
4190
4272
  "abstract": true,
4191
4273
  "docs": {
4192
- "default": "default master key",
4193
4274
  "stability": "experimental",
4194
- "summary": "The KMS key to use to encrypt the secret."
4275
+ "summary": "The username."
4195
4276
  },
4196
4277
  "immutable": true,
4197
4278
  "locationInModule": {
4198
4279
  "filename": "lib/database-secret.ts",
4199
- "line": 19
4280
+ "line": 12
4200
4281
  },
4201
- "name": "encryptionKey",
4202
- "optional": true,
4282
+ "name": "username",
4203
4283
  "type": {
4204
- "fqn": "aws-cdk-lib.aws_kms.IKey"
4284
+ "primitive": "string"
4205
4285
  }
4206
4286
  },
4207
4287
  {
4208
4288
  "abstract": true,
4209
4289
  "docs": {
4290
+ "default": "default master key",
4210
4291
  "stability": "experimental",
4211
- "summary": "The username."
4292
+ "summary": "The KMS key to use to encrypt the secret."
4212
4293
  },
4213
4294
  "immutable": true,
4214
4295
  "locationInModule": {
4215
4296
  "filename": "lib/database-secret.ts",
4216
- "line": 12
4297
+ "line": 19
4217
4298
  },
4218
- "name": "username",
4299
+ "name": "encryptionKey",
4300
+ "optional": true,
4219
4301
  "type": {
4220
- "primitive": "string"
4302
+ "fqn": "aws-cdk-lib.aws_kms.IKey"
4221
4303
  }
4222
4304
  }
4223
4305
  ],
@@ -4229,7 +4311,7 @@
4229
4311
  "remarks": "Consists of a combination of hostname and port.",
4230
4312
  "stability": "experimental",
4231
4313
  "summary": "Connection endpoint of a redshift cluster.",
4232
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\n\nconst endpoint = new redshift_alpha.Endpoint('address', 123);",
4314
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as redshift_alpha from '@aws-cdk/aws-redshift-alpha';\nconst endpoint = new redshift_alpha.Endpoint('address', 123);",
4233
4315
  "custom": {
4234
4316
  "exampleMetadata": "fixture=_generated"
4235
4317
  }
@@ -4689,6 +4771,9 @@
4689
4771
  "assembly": "@aws-cdk/aws-redshift-alpha",
4690
4772
  "datatype": true,
4691
4773
  "docs": {
4774
+ "custom": {
4775
+ "exampleMetadata": "fixture=cluster infused"
4776
+ },
4692
4777
  "example": "import * as kms from 'aws-cdk-lib/aws-kms';\n\nconst encryptionKey = new kms.Key(this, 'Key');\nnew User(this, 'User', {\n encryptionKey: encryptionKey,\n cluster: cluster,\n databaseName: 'databaseName',\n});",
4693
4778
  "stability": "experimental",
4694
4779
  "summary": "Username and password combination."
@@ -4841,6 +4926,9 @@
4841
4926
  "assembly": "@aws-cdk/aws-redshift-alpha",
4842
4927
  "datatype": true,
4843
4928
  "docs": {
4929
+ "custom": {
4930
+ "exampleMetadata": "fixture=cluster infused"
4931
+ },
4844
4932
  "example": "import * as secretsmanager from 'aws-cdk-lib/aws-secretsmanager';\n\ncluster.addRotationMultiUser('MyUser', {\n secret: secretsmanager.Secret.fromSecretNameV2(this, 'Imported Secret', 'my-secret'),\n});",
4845
4933
  "stability": "experimental",
4846
4934
  "summary": "Options to add the multi user rotation."
@@ -4895,6 +4983,9 @@
4895
4983
  "assembly": "@aws-cdk/aws-redshift-alpha",
4896
4984
  "base": "constructs.Construct",
4897
4985
  "docs": {
4986
+ "custom": {
4987
+ "exampleMetadata": "fixture=cluster infused"
4988
+ },
4898
4989
  "example": "new Table(this, 'Table', {\n tableColumns: [\n { name: 'col1', dataType: 'varchar(4)', distKey: true },\n { name: 'col2', dataType: 'float' },\n ],\n cluster: cluster,\n databaseName: 'databaseName',\n distStyle: TableDistStyle.KEY,\n});",
4899
4990
  "stability": "experimental",
4900
4991
  "summary": "A table in a Redshift cluster."
@@ -5101,6 +5192,9 @@
5101
5192
  "@aws-cdk/aws-redshift-alpha.TableAction": {
5102
5193
  "assembly": "@aws-cdk/aws-redshift-alpha",
5103
5194
  "docs": {
5195
+ "custom": {
5196
+ "exampleMetadata": "fixture=cluster infused"
5197
+ },
5104
5198
  "example": "const databaseName = 'databaseName';\nconst username = 'myuser'\nconst tableName = 'mytable'\n\nconst user = new User(this, 'User', {\n username: username,\n cluster: cluster,\n databaseName: databaseName,\n});\nconst table = new Table(this, 'Table', {\n tableColumns: [{ name: 'col1', dataType: 'varchar(4)' }, { name: 'col2', dataType: 'float' }],\n cluster: cluster,\n databaseName: databaseName,\n});\ntable.grant(user, TableAction.INSERT);",
5105
5199
  "stability": "experimental",
5106
5200
  "summary": "An action that a Redshift user can be granted privilege to perform on a table."
@@ -5170,6 +5264,9 @@
5170
5264
  "assembly": "@aws-cdk/aws-redshift-alpha",
5171
5265
  "datatype": true,
5172
5266
  "docs": {
5267
+ "custom": {
5268
+ "exampleMetadata": "fixture=cluster infused"
5269
+ },
5173
5270
  "example": "const databaseName = 'databaseName';\nconst username = 'myuser'\nconst tableName = 'mytable'\n\nconst user = User.fromUserAttributes(this, 'User', {\n username: username,\n password: SecretValue.plainText('NOT_FOR_PRODUCTION'),\n cluster: cluster,\n databaseName: databaseName,\n});\nconst table = Table.fromTableAttributes(this, 'Table', {\n tableName: tableName,\n tableColumns: [{ name: 'col1', dataType: 'varchar(4)' }, { name: 'col2', dataType: 'float' }],\n cluster: cluster,\n databaseName: 'databaseName',\n});\ntable.grant(user, TableAction.INSERT);",
5174
5271
  "stability": "experimental",
5175
5272
  "summary": "A full specification of a Redshift table that can be used to import it fluently into the CDK application."
@@ -5257,6 +5354,9 @@
5257
5354
  "@aws-cdk/aws-redshift-alpha.TableDistStyle": {
5258
5355
  "assembly": "@aws-cdk/aws-redshift-alpha",
5259
5356
  "docs": {
5357
+ "custom": {
5358
+ "exampleMetadata": "fixture=cluster infused"
5359
+ },
5260
5360
  "example": "new Table(this, 'Table', {\n tableColumns: [\n { name: 'col1', dataType: 'varchar(4)', distKey: true },\n { name: 'col2', dataType: 'float' },\n ],\n cluster: cluster,\n databaseName: 'databaseName',\n distStyle: TableDistStyle.KEY,\n});",
5261
5361
  "stability": "experimental",
5262
5362
  "summary": "The data distribution style of a table."
@@ -5304,6 +5404,9 @@
5304
5404
  "assembly": "@aws-cdk/aws-redshift-alpha",
5305
5405
  "datatype": true,
5306
5406
  "docs": {
5407
+ "custom": {
5408
+ "exampleMetadata": "fixture=cluster infused"
5409
+ },
5307
5410
  "example": "new Table(this, 'Table', {\n tableColumns: [\n { name: 'col1', dataType: 'varchar(4)', distKey: true },\n { name: 'col2', dataType: 'float' },\n ],\n cluster: cluster,\n databaseName: 'databaseName',\n distStyle: TableDistStyle.KEY,\n});",
5308
5411
  "stability": "experimental",
5309
5412
  "summary": "Properties for configuring a Redshift table."
@@ -5418,6 +5521,9 @@
5418
5521
  "@aws-cdk/aws-redshift-alpha.TableSortStyle": {
5419
5522
  "assembly": "@aws-cdk/aws-redshift-alpha",
5420
5523
  "docs": {
5524
+ "custom": {
5525
+ "exampleMetadata": "fixture=cluster infused"
5526
+ },
5421
5527
  "example": "new Table(this, 'Table', {\n tableColumns: [\n { name: 'col1', dataType: 'varchar(4)', sortKey: true },\n { name: 'col2', dataType: 'float', sortKey: true },\n ],\n cluster: cluster,\n databaseName: 'databaseName',\n sortStyle: TableSortStyle.COMPOUND,\n});",
5422
5528
  "stability": "experimental",
5423
5529
  "summary": "The sort style of a table."
@@ -5458,6 +5564,9 @@
5458
5564
  "assembly": "@aws-cdk/aws-redshift-alpha",
5459
5565
  "base": "constructs.Construct",
5460
5566
  "docs": {
5567
+ "custom": {
5568
+ "exampleMetadata": "fixture=cluster infused"
5569
+ },
5461
5570
  "example": "import * as kms from 'aws-cdk-lib/aws-kms';\n\nconst encryptionKey = new kms.Key(this, 'Key');\nnew User(this, 'User', {\n encryptionKey: encryptionKey,\n cluster: cluster,\n databaseName: 'databaseName',\n});",
5462
5571
  "stability": "experimental",
5463
5572
  "summary": "A user in a Redshift cluster."
@@ -5674,6 +5783,9 @@
5674
5783
  "assembly": "@aws-cdk/aws-redshift-alpha",
5675
5784
  "datatype": true,
5676
5785
  "docs": {
5786
+ "custom": {
5787
+ "exampleMetadata": "fixture=cluster infused"
5788
+ },
5677
5789
  "example": "const databaseName = 'databaseName';\nconst username = 'myuser'\nconst tableName = 'mytable'\n\nconst user = User.fromUserAttributes(this, 'User', {\n username: username,\n password: SecretValue.plainText('NOT_FOR_PRODUCTION'),\n cluster: cluster,\n databaseName: databaseName,\n});\nconst table = Table.fromTableAttributes(this, 'Table', {\n tableName: tableName,\n tableColumns: [{ name: 'col1', dataType: 'varchar(4)' }, { name: 'col2', dataType: 'float' }],\n cluster: cluster,\n databaseName: 'databaseName',\n});\ntable.grant(user, TableAction.INSERT);",
5678
5790
  "stability": "experimental",
5679
5791
  "summary": "A full specification of a Redshift user that can be used to import it fluently into the CDK application."
@@ -5729,6 +5841,9 @@
5729
5841
  "assembly": "@aws-cdk/aws-redshift-alpha",
5730
5842
  "datatype": true,
5731
5843
  "docs": {
5844
+ "custom": {
5845
+ "exampleMetadata": "fixture=cluster infused"
5846
+ },
5732
5847
  "example": "import * as kms from 'aws-cdk-lib/aws-kms';\n\nconst encryptionKey = new kms.Key(this, 'Key');\nnew User(this, 'User', {\n encryptionKey: encryptionKey,\n cluster: cluster,\n databaseName: 'databaseName',\n});",
5733
5848
  "stability": "experimental",
5734
5849
  "summary": "Properties for configuring a Redshift user."
@@ -5803,6 +5918,6 @@
5803
5918
  "symbolId": "lib/user:UserProps"
5804
5919
  }
5805
5920
  },
5806
- "version": "2.1.0-alpha.0",
5921
+ "version": "2.5.0-alpha.0",
5807
5922
  "fingerprint": "**********"
5808
5923
  }