@awboost/cfn-resource-types 0.1.122 → 0.1.124
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/lib/AWS-Bedrock-Guardrail.d.ts +38 -0
- package/lib/AWS-EC2-VPNConnection.d.ts +43 -11
- package/lib/AWS-EC2-VPNConnection.js +5 -1
- package/lib/AWS-EC2-VPNConnectionRoute.d.ts +6 -2
- package/lib/AWS-EC2-VPNConnectionRoute.js +3 -1
- package/lib/AWS-EMRServerless-Application.d.ts +15 -0
- package/lib/AWS-KinesisFirehose-DeliveryStream.d.ts +0 -1
- package/lib/AWS-NetworkFirewall-LoggingConfiguration.d.ts +1 -1
- package/lib/AWS-OSIS-Pipeline.d.ts +28 -0
- package/lib/AWS-Panorama-ApplicationInstance.d.ts +18 -5
- package/lib/AWS-Panorama-ApplicationInstance.js +1 -1
- package/lib/AWS-Panorama-Package.d.ts +24 -2
- package/lib/AWS-Panorama-Package.js +1 -1
- package/lib/AWS-Panorama-PackageVersion.d.ts +10 -2
- package/lib/AWS-Panorama-PackageVersion.js +1 -1
- package/lib/AWS-RDS-DBCluster.d.ts +10 -12
- package/lib/AWS-RDS-DBCluster.js +2 -2
- package/lib/AWS-RDS-DBClusterParameterGroup.d.ts +23 -11
- package/lib/AWS-RDS-DBClusterParameterGroup.js +1 -1
- package/lib/AWS-RDS-DBInstance.d.ts +36 -28
- package/lib/AWS-RDS-DBInstance.js +1 -1
- package/lib/AWS-RDS-DBParameterGroup.d.ts +26 -14
- package/lib/AWS-RDS-DBSubnetGroup.d.ts +7 -3
- package/lib/AWS-RDS-EventSubscription.d.ts +4 -3
- package/lib/AWS-RDS-OptionGroup.d.ts +2 -2
- package/lib/AWS-SNS-Topic.d.ts +24 -0
- package/lib/AWS-SageMaker-StudioLifecycleConfig.d.ts +70 -0
- package/lib/AWS-SageMaker-StudioLifecycleConfig.js +12 -0
- package/package.json +1 -1
|
@@ -21,6 +21,10 @@ export type BedrockGuardrailProperties = {
|
|
|
21
21
|
* Content policy config for a guardrail.
|
|
22
22
|
*/
|
|
23
23
|
ContentPolicyConfig?: ContentPolicyConfig;
|
|
24
|
+
/**
|
|
25
|
+
* Contextual grounding policy config for a guardrail.
|
|
26
|
+
*/
|
|
27
|
+
ContextualGroundingPolicyConfig?: ContextualGroundingPolicyConfig;
|
|
24
28
|
/**
|
|
25
29
|
* Description of the guardrail or its version
|
|
26
30
|
* @minLength `1`
|
|
@@ -143,6 +147,40 @@ export type ContentPolicyConfig = {
|
|
|
143
147
|
*/
|
|
144
148
|
FiltersConfig: ContentFilterConfig[];
|
|
145
149
|
};
|
|
150
|
+
/**
|
|
151
|
+
* Type definition for `AWS::Bedrock::Guardrail.ContextualGroundingFilterConfig`.
|
|
152
|
+
* A config for grounding filter.
|
|
153
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.html}
|
|
154
|
+
*/
|
|
155
|
+
export type ContextualGroundingFilterConfig = {
|
|
156
|
+
/**
|
|
157
|
+
* The threshold for this filter.
|
|
158
|
+
* @min `0`
|
|
159
|
+
*/
|
|
160
|
+
Threshold: number;
|
|
161
|
+
/**
|
|
162
|
+
* Type of contextual grounding filter
|
|
163
|
+
*/
|
|
164
|
+
Type: ContextualGroundingFilterType;
|
|
165
|
+
};
|
|
166
|
+
/**
|
|
167
|
+
* Type definition for `AWS::Bedrock::Guardrail.ContextualGroundingFilterType`.
|
|
168
|
+
* Type of contextual grounding filter
|
|
169
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingfiltertype.html}
|
|
170
|
+
*/
|
|
171
|
+
export type ContextualGroundingFilterType = "GROUNDING" | "RELEVANCE";
|
|
172
|
+
/**
|
|
173
|
+
* Type definition for `AWS::Bedrock::Guardrail.ContextualGroundingPolicyConfig`.
|
|
174
|
+
* Contextual grounding policy config for a guardrail.
|
|
175
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contextualgroundingpolicyconfig.html}
|
|
176
|
+
*/
|
|
177
|
+
export type ContextualGroundingPolicyConfig = {
|
|
178
|
+
/**
|
|
179
|
+
* List of contextual grounding filter configs.
|
|
180
|
+
* @minLength `1`
|
|
181
|
+
*/
|
|
182
|
+
FiltersConfig: ContextualGroundingFilterConfig[];
|
|
183
|
+
};
|
|
146
184
|
/**
|
|
147
185
|
* Type definition for `AWS::Bedrock::Guardrail.FilterStrength`.
|
|
148
186
|
* Strength for filters
|
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
2
|
import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
|
|
3
3
|
/**
|
|
4
|
-
* Resource
|
|
4
|
+
* Resource type definition for `AWS::EC2::VPNConnection`.
|
|
5
|
+
* Specifies a VPN connection between a virtual private gateway and a VPN customer gateway or a transit gateway and a VPN customer gateway.
|
|
6
|
+
To specify a VPN connection between a transit gateway and customer gateway, use the ``TransitGatewayId`` and ``CustomerGatewayId`` properties.
|
|
7
|
+
To specify a VPN connection between a virtual private gateway and customer gateway, use the ``VpnGatewayId`` and ``CustomerGatewayId`` properties.
|
|
8
|
+
For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.
|
|
5
9
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html}
|
|
6
10
|
*/
|
|
7
11
|
export type EC2VPNConnectionProperties = {
|
|
@@ -9,25 +13,29 @@ export type EC2VPNConnectionProperties = {
|
|
|
9
13
|
* The ID of the customer gateway at your end of the VPN connection.
|
|
10
14
|
*/
|
|
11
15
|
CustomerGatewayId: string;
|
|
16
|
+
EnableAcceleration?: boolean;
|
|
12
17
|
/**
|
|
13
|
-
|
|
14
|
-
|
|
18
|
+
* Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
|
|
19
|
+
If you are creating a VPN connection for a device that does not support Border Gateway Protocol (BGP), you must specify ``true``.
|
|
20
|
+
*/
|
|
15
21
|
StaticRoutesOnly?: boolean;
|
|
16
22
|
/**
|
|
17
23
|
* Any tags assigned to the VPN connection.
|
|
18
24
|
*/
|
|
19
25
|
Tags?: Tag[];
|
|
20
26
|
/**
|
|
21
|
-
|
|
22
|
-
|
|
27
|
+
* The ID of the transit gateway associated with the VPN connection.
|
|
28
|
+
You must specify either ``TransitGatewayId`` or ``VpnGatewayId``, but not both.
|
|
29
|
+
*/
|
|
23
30
|
TransitGatewayId?: string;
|
|
24
31
|
/**
|
|
25
32
|
* The type of VPN connection.
|
|
26
33
|
*/
|
|
27
34
|
Type: string;
|
|
28
35
|
/**
|
|
29
|
-
|
|
30
|
-
|
|
36
|
+
* The ID of the virtual private gateway at the AWS side of the VPN connection.
|
|
37
|
+
You must specify either ``TransitGatewayId`` or ``VpnGatewayId``, but not both.
|
|
38
|
+
*/
|
|
31
39
|
VpnGatewayId?: string;
|
|
32
40
|
/**
|
|
33
41
|
* The tunnel options for the VPN connection.
|
|
@@ -39,29 +47,53 @@ export type EC2VPNConnectionProperties = {
|
|
|
39
47
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html#aws-resource-ec2-vpnconnection-return-values}
|
|
40
48
|
*/
|
|
41
49
|
export type EC2VPNConnectionAttributes = {
|
|
42
|
-
/**
|
|
43
|
-
* The provider-assigned unique ID for this managed resource
|
|
44
|
-
*/
|
|
45
50
|
VpnConnectionId: string;
|
|
46
51
|
};
|
|
47
52
|
/**
|
|
48
53
|
* Type definition for `AWS::EC2::VPNConnection.Tag`.
|
|
54
|
+
* Specifies a tag. For more information, see [Add tags to a resource](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#cloudformation-add-tag-specifications).
|
|
49
55
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-tag.html}
|
|
50
56
|
*/
|
|
51
57
|
export type Tag = {
|
|
58
|
+
/**
|
|
59
|
+
* The tag key.
|
|
60
|
+
*/
|
|
52
61
|
Key: string;
|
|
62
|
+
/**
|
|
63
|
+
* The tag value.
|
|
64
|
+
*/
|
|
53
65
|
Value: string;
|
|
54
66
|
};
|
|
55
67
|
/**
|
|
56
68
|
* Type definition for `AWS::EC2::VPNConnection.VpnTunnelOptionsSpecification`.
|
|
69
|
+
* The tunnel options for a single VPN tunnel.
|
|
57
70
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-vpnconnection-vpntunneloptionsspecification.html}
|
|
58
71
|
*/
|
|
59
72
|
export type VpnTunnelOptionsSpecification = {
|
|
73
|
+
/**
|
|
74
|
+
* The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.
|
|
75
|
+
Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).
|
|
76
|
+
*/
|
|
60
77
|
PreSharedKey?: string;
|
|
78
|
+
/**
|
|
79
|
+
* The range of inside IP addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.
|
|
80
|
+
Constraints: A size /30 CIDR block from the ``169.254.0.0/16`` range. The following CIDR blocks are reserved and cannot be used:
|
|
81
|
+
+ ``169.254.0.0/30``
|
|
82
|
+
+ ``169.254.1.0/30``
|
|
83
|
+
+ ``169.254.2.0/30``
|
|
84
|
+
+ ``169.254.3.0/30``
|
|
85
|
+
+ ``169.254.4.0/30``
|
|
86
|
+
+ ``169.254.5.0/30``
|
|
87
|
+
+ ``169.254.169.252/30``
|
|
88
|
+
*/
|
|
61
89
|
TunnelInsideCidr?: string;
|
|
62
90
|
};
|
|
63
91
|
/**
|
|
64
|
-
* Resource
|
|
92
|
+
* Resource type definition for `AWS::EC2::VPNConnection`.
|
|
93
|
+
* Specifies a VPN connection between a virtual private gateway and a VPN customer gateway or a transit gateway and a VPN customer gateway.
|
|
94
|
+
To specify a VPN connection between a transit gateway and customer gateway, use the ``TransitGatewayId`` and ``CustomerGatewayId`` properties.
|
|
95
|
+
To specify a VPN connection between a virtual private gateway and customer gateway, use the ``VpnGatewayId`` and ``CustomerGatewayId`` properties.
|
|
96
|
+
For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.
|
|
65
97
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html}
|
|
66
98
|
*/
|
|
67
99
|
export declare class EC2VPNConnection extends $Resource<"AWS::EC2::VPNConnection", EC2VPNConnectionProperties, EC2VPNConnectionAttributes> {
|
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
2
|
/**
|
|
3
|
-
* Resource
|
|
3
|
+
* Resource type definition for `AWS::EC2::VPNConnection`.
|
|
4
|
+
* Specifies a VPN connection between a virtual private gateway and a VPN customer gateway or a transit gateway and a VPN customer gateway.
|
|
5
|
+
To specify a VPN connection between a transit gateway and customer gateway, use the ``TransitGatewayId`` and ``CustomerGatewayId`` properties.
|
|
6
|
+
To specify a VPN connection between a virtual private gateway and customer gateway, use the ``VpnGatewayId`` and ``CustomerGatewayId`` properties.
|
|
7
|
+
For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.
|
|
4
8
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnection.html}
|
|
5
9
|
*/
|
|
6
10
|
export class EC2VPNConnection extends $Resource {
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
2
|
import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
|
|
3
3
|
/**
|
|
4
|
-
* Resource
|
|
4
|
+
* Resource type definition for `AWS::EC2::VPNConnectionRoute`.
|
|
5
|
+
* Specifies a static route for a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
|
|
6
|
+
For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.
|
|
5
7
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnectionroute.html}
|
|
6
8
|
*/
|
|
7
9
|
export type EC2VPNConnectionRouteProperties = {
|
|
@@ -15,7 +17,9 @@ export type EC2VPNConnectionRouteProperties = {
|
|
|
15
17
|
VpnConnectionId: string;
|
|
16
18
|
};
|
|
17
19
|
/**
|
|
18
|
-
* Resource
|
|
20
|
+
* Resource type definition for `AWS::EC2::VPNConnectionRoute`.
|
|
21
|
+
* Specifies a static route for a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
|
|
22
|
+
For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.
|
|
19
23
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnectionroute.html}
|
|
20
24
|
*/
|
|
21
25
|
export declare class EC2VPNConnectionRoute extends $Resource<"AWS::EC2::VPNConnectionRoute", EC2VPNConnectionRouteProperties, Record<string, never>> {
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
2
|
/**
|
|
3
|
-
* Resource
|
|
3
|
+
* Resource type definition for `AWS::EC2::VPNConnectionRoute`.
|
|
4
|
+
* Specifies a static route for a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.
|
|
5
|
+
For more information, see [](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the *User Guide*.
|
|
4
6
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpnconnectionroute.html}
|
|
5
7
|
*/
|
|
6
8
|
export class EC2VPNConnectionRoute extends $Resource {
|
|
@@ -25,6 +25,7 @@ export type EMRServerlessApplicationProperties = {
|
|
|
25
25
|
* Initial capacity initialized when an Application is started.
|
|
26
26
|
*/
|
|
27
27
|
InitialCapacity?: InitialCapacityConfigKeyValuePair[];
|
|
28
|
+
InteractiveConfiguration?: InteractiveConfiguration;
|
|
28
29
|
/**
|
|
29
30
|
* Maximum allowed cumulative resources for an Application. No new resources will be created once the limit is hit.
|
|
30
31
|
*/
|
|
@@ -209,6 +210,20 @@ export type InitialCapacityConfigKeyValuePair = {
|
|
|
209
210
|
Key: string;
|
|
210
211
|
Value: InitialCapacityConfig;
|
|
211
212
|
};
|
|
213
|
+
/**
|
|
214
|
+
* Type definition for `AWS::EMRServerless::Application.InteractiveConfiguration`.
|
|
215
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-interactiveconfiguration.html}
|
|
216
|
+
*/
|
|
217
|
+
export type InteractiveConfiguration = {
|
|
218
|
+
/**
|
|
219
|
+
* Enables an Apache Livy endpoint that you can connect to and run interactive jobs
|
|
220
|
+
*/
|
|
221
|
+
LivyEndpointEnabled?: boolean;
|
|
222
|
+
/**
|
|
223
|
+
* Enabled you to connect an Application to Amazon EMR Studio to run interactive workloads in a notebook
|
|
224
|
+
*/
|
|
225
|
+
StudioEnabled?: boolean;
|
|
226
|
+
};
|
|
212
227
|
/**
|
|
213
228
|
* Type definition for `AWS::EMRServerless::Application.LogTypeMapKeyValuePair`.
|
|
214
229
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrserverless-application-logtypemapkeyvaluepair.html}
|
|
@@ -30,7 +30,7 @@ export type LogDestinationConfig = {
|
|
|
30
30
|
*/
|
|
31
31
|
LogDestination: Record<string, string>;
|
|
32
32
|
LogDestinationType: "S3" | "CloudWatchLogs" | "KinesisDataFirehose";
|
|
33
|
-
LogType: "ALERT" | "FLOW";
|
|
33
|
+
LogType: "ALERT" | "FLOW" | "TLS";
|
|
34
34
|
};
|
|
35
35
|
/**
|
|
36
36
|
* Type definition for `AWS::NetworkFirewall::LoggingConfiguration.LoggingConfiguration`.
|
|
@@ -98,6 +98,20 @@ export type OSISPipelineAttributes = {
|
|
|
98
98
|
* A list of subnet IDs associated with the VPC endpoint.
|
|
99
99
|
*/
|
|
100
100
|
SubnetIds: string[];
|
|
101
|
+
/**
|
|
102
|
+
* Options for attaching a VPC to the pipeline.
|
|
103
|
+
*/
|
|
104
|
+
VpcAttachmentOptions: {
|
|
105
|
+
/**
|
|
106
|
+
* Whether the pipeline should be attached to the provided VPC
|
|
107
|
+
*/
|
|
108
|
+
AttachToVpc: boolean;
|
|
109
|
+
/**
|
|
110
|
+
* The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
|
|
111
|
+
* @pattern `^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(3[0-2]|[12]?[0-9])$`
|
|
112
|
+
*/
|
|
113
|
+
CidrBlock: string;
|
|
114
|
+
};
|
|
101
115
|
/**
|
|
102
116
|
* Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.
|
|
103
117
|
*/
|
|
@@ -201,6 +215,20 @@ export type VpcOptions = {
|
|
|
201
215
|
* A list of subnet IDs associated with the VPC endpoint.
|
|
202
216
|
*/
|
|
203
217
|
SubnetIds: string[];
|
|
218
|
+
/**
|
|
219
|
+
* Options for attaching a VPC to the pipeline.
|
|
220
|
+
*/
|
|
221
|
+
VpcAttachmentOptions?: {
|
|
222
|
+
/**
|
|
223
|
+
* Whether the pipeline should be attached to the provided VPC
|
|
224
|
+
*/
|
|
225
|
+
AttachToVpc: boolean;
|
|
226
|
+
/**
|
|
227
|
+
* The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
|
|
228
|
+
* @pattern `^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(3[0-2]|[12]?[0-9])$`
|
|
229
|
+
*/
|
|
230
|
+
CidrBlock: string;
|
|
231
|
+
};
|
|
204
232
|
/**
|
|
205
233
|
* Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.
|
|
206
234
|
*/
|
|
@@ -2,44 +2,55 @@ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/re
|
|
|
2
2
|
import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
|
|
3
3
|
/**
|
|
4
4
|
* Resource type definition for `AWS::Panorama::ApplicationInstance`.
|
|
5
|
-
*
|
|
5
|
+
* Creates an application instance and deploys it to a device.
|
|
6
6
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-panorama-applicationinstance.html}
|
|
7
7
|
*/
|
|
8
8
|
export type PanoramaApplicationInstanceProperties = {
|
|
9
9
|
/**
|
|
10
|
+
* The ID of an application instance to replace with the new instance.
|
|
10
11
|
* @minLength `1`
|
|
11
12
|
* @maxLength `255`
|
|
12
13
|
* @pattern `^[a-zA-Z0-9\-\_]+$`
|
|
13
14
|
*/
|
|
14
15
|
ApplicationInstanceIdToReplace?: string;
|
|
15
16
|
/**
|
|
17
|
+
* The device's ID.
|
|
16
18
|
* @minLength `1`
|
|
17
19
|
* @maxLength `255`
|
|
18
20
|
* @pattern `^[a-zA-Z0-9\-\_]+$`
|
|
19
21
|
*/
|
|
20
22
|
DefaultRuntimeContextDevice: string;
|
|
21
23
|
/**
|
|
24
|
+
* A description for the application instance.
|
|
22
25
|
* @minLength `0`
|
|
23
26
|
* @maxLength `255`
|
|
24
27
|
* @pattern `^.*$`
|
|
25
28
|
*/
|
|
26
29
|
Description?: string;
|
|
30
|
+
/**
|
|
31
|
+
* Setting overrides for the application manifest.
|
|
32
|
+
*/
|
|
27
33
|
ManifestOverridesPayload?: ManifestOverridesPayload;
|
|
34
|
+
/**
|
|
35
|
+
* The application's manifest document.
|
|
36
|
+
*/
|
|
28
37
|
ManifestPayload: ManifestPayload;
|
|
29
38
|
/**
|
|
39
|
+
* A name for the application instance.
|
|
30
40
|
* @minLength `1`
|
|
31
41
|
* @maxLength `255`
|
|
32
42
|
* @pattern `^[a-zA-Z0-9\-\_]+$`
|
|
33
43
|
*/
|
|
34
44
|
Name?: string;
|
|
35
45
|
/**
|
|
46
|
+
* The ARN of a runtime role for the application instance.
|
|
36
47
|
* @minLength `1`
|
|
37
48
|
* @maxLength `255`
|
|
38
49
|
* @pattern `^arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:role/.+$`
|
|
39
50
|
*/
|
|
40
51
|
RuntimeRoleArn?: string;
|
|
41
52
|
/**
|
|
42
|
-
*
|
|
53
|
+
* Tags for the application instance.
|
|
43
54
|
*/
|
|
44
55
|
Tags?: Tag[];
|
|
45
56
|
};
|
|
@@ -87,10 +98,12 @@ export type ApplicationInstanceHealthStatus = "RUNNING" | "ERROR" | "NOT_AVAILAB
|
|
|
87
98
|
export type ApplicationInstanceStatus = "DEPLOYMENT_PENDING" | "DEPLOYMENT_REQUESTED" | "DEPLOYMENT_IN_PROGRESS" | "DEPLOYMENT_ERROR" | "DEPLOYMENT_SUCCEEDED" | "REMOVAL_PENDING" | "REMOVAL_REQUESTED" | "REMOVAL_IN_PROGRESS" | "REMOVAL_FAILED" | "REMOVAL_SUCCEEDED";
|
|
88
99
|
/**
|
|
89
100
|
* Type definition for `AWS::Panorama::ApplicationInstance.ManifestOverridesPayload`.
|
|
101
|
+
* Parameter overrides for an application instance. This is a JSON document that has a single key (``PayloadData``) where the value is an escaped string representation of the overrides document.
|
|
90
102
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-panorama-applicationinstance-manifestoverridespayload.html}
|
|
91
103
|
*/
|
|
92
104
|
export type ManifestOverridesPayload = {
|
|
93
105
|
/**
|
|
106
|
+
* The overrides document.
|
|
94
107
|
* @minLength `0`
|
|
95
108
|
* @maxLength `51200`
|
|
96
109
|
* @pattern `^.+$`
|
|
@@ -99,10 +112,12 @@ export type ManifestOverridesPayload = {
|
|
|
99
112
|
};
|
|
100
113
|
/**
|
|
101
114
|
* Type definition for `AWS::Panorama::ApplicationInstance.ManifestPayload`.
|
|
115
|
+
* A application verion's manifest file. This is a JSON document that has a single key (``PayloadData``) where the value is an escaped string representation of the application manifest (``graph.json``). This file is located in the ``graphs`` folder in your application source.
|
|
102
116
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-panorama-applicationinstance-manifestpayload.html}
|
|
103
117
|
*/
|
|
104
118
|
export type ManifestPayload = {
|
|
105
119
|
/**
|
|
120
|
+
* The application manifest.
|
|
106
121
|
* @minLength `1`
|
|
107
122
|
* @maxLength `51200`
|
|
108
123
|
* @pattern `^.+$`
|
|
@@ -115,14 +130,12 @@ export type ManifestPayload = {
|
|
|
115
130
|
*/
|
|
116
131
|
export type Tag = {
|
|
117
132
|
/**
|
|
118
|
-
* A string used to identify this tag
|
|
119
133
|
* @minLength `1`
|
|
120
134
|
* @maxLength `128`
|
|
121
135
|
* @pattern `^.+$`
|
|
122
136
|
*/
|
|
123
137
|
Key: string;
|
|
124
138
|
/**
|
|
125
|
-
* A string containing the value for the tag
|
|
126
139
|
* @minLength `0`
|
|
127
140
|
* @maxLength `256`
|
|
128
141
|
* @pattern `^.+$`
|
|
@@ -131,7 +144,7 @@ export type Tag = {
|
|
|
131
144
|
};
|
|
132
145
|
/**
|
|
133
146
|
* Resource type definition for `AWS::Panorama::ApplicationInstance`.
|
|
134
|
-
*
|
|
147
|
+
* Creates an application instance and deploys it to a device.
|
|
135
148
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-panorama-applicationinstance.html}
|
|
136
149
|
*/
|
|
137
150
|
export declare class PanoramaApplicationInstance extends $Resource<"AWS::Panorama::ApplicationInstance", PanoramaApplicationInstanceProperties, PanoramaApplicationInstanceAttributes> {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
2
|
/**
|
|
3
3
|
* Resource type definition for `AWS::Panorama::ApplicationInstance`.
|
|
4
|
-
*
|
|
4
|
+
* Creates an application instance and deploys it to a device.
|
|
5
5
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-panorama-applicationinstance.html}
|
|
6
6
|
*/
|
|
7
7
|
export class PanoramaApplicationInstance extends $Resource {
|
|
@@ -2,16 +2,20 @@ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/re
|
|
|
2
2
|
import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
|
|
3
3
|
/**
|
|
4
4
|
* Resource type definition for `AWS::Panorama::Package`.
|
|
5
|
-
*
|
|
5
|
+
* Creates a package and storage location in an Amazon S3 access point.
|
|
6
6
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-panorama-package.html}
|
|
7
7
|
*/
|
|
8
8
|
export type PanoramaPackageProperties = {
|
|
9
9
|
/**
|
|
10
|
+
* A name for the package.
|
|
10
11
|
* @minLength `1`
|
|
11
12
|
* @maxLength `128`
|
|
12
13
|
* @pattern `^[a-zA-Z0-9\-\_]+$`
|
|
13
14
|
*/
|
|
14
15
|
PackageName: string;
|
|
16
|
+
/**
|
|
17
|
+
* Tags for the package.
|
|
18
|
+
*/
|
|
15
19
|
Tags?: Tag[];
|
|
16
20
|
};
|
|
17
21
|
/**
|
|
@@ -31,11 +35,29 @@ export type PanoramaPackageAttributes = {
|
|
|
31
35
|
* @pattern `^[a-zA-Z0-9\-\_\/]+$`
|
|
32
36
|
*/
|
|
33
37
|
PackageId: string;
|
|
38
|
+
/**
|
|
39
|
+
* A storage location.
|
|
40
|
+
*/
|
|
34
41
|
StorageLocation: {
|
|
42
|
+
/**
|
|
43
|
+
* The location's binary prefix.
|
|
44
|
+
*/
|
|
35
45
|
BinaryPrefixLocation: string;
|
|
46
|
+
/**
|
|
47
|
+
* The location's bucket.
|
|
48
|
+
*/
|
|
36
49
|
Bucket: string;
|
|
50
|
+
/**
|
|
51
|
+
* The location's generated prefix.
|
|
52
|
+
*/
|
|
37
53
|
GeneratedPrefixLocation: string;
|
|
54
|
+
/**
|
|
55
|
+
* The location's manifest prefix.
|
|
56
|
+
*/
|
|
38
57
|
ManifestPrefixLocation: string;
|
|
58
|
+
/**
|
|
59
|
+
* The location's repo prefix.
|
|
60
|
+
*/
|
|
39
61
|
RepoPrefixLocation: string;
|
|
40
62
|
};
|
|
41
63
|
};
|
|
@@ -59,7 +81,7 @@ export type Tag = {
|
|
|
59
81
|
};
|
|
60
82
|
/**
|
|
61
83
|
* Resource type definition for `AWS::Panorama::Package`.
|
|
62
|
-
*
|
|
84
|
+
* Creates a package and storage location in an Amazon S3 access point.
|
|
63
85
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-panorama-package.html}
|
|
64
86
|
*/
|
|
65
87
|
export declare class PanoramaPackage extends $Resource<"AWS::Panorama::Package", PanoramaPackageProperties, PanoramaPackageAttributes> {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
2
|
/**
|
|
3
3
|
* Resource type definition for `AWS::Panorama::Package`.
|
|
4
|
-
*
|
|
4
|
+
* Creates a package and storage location in an Amazon S3 access point.
|
|
5
5
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-panorama-package.html}
|
|
6
6
|
*/
|
|
7
7
|
export class PanoramaPackage extends $Resource {
|
|
@@ -2,36 +2,44 @@ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/re
|
|
|
2
2
|
import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
|
|
3
3
|
/**
|
|
4
4
|
* Resource type definition for `AWS::Panorama::PackageVersion`.
|
|
5
|
-
*
|
|
5
|
+
* Registers a package version.
|
|
6
6
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-panorama-packageversion.html}
|
|
7
7
|
*/
|
|
8
8
|
export type PanoramaPackageVersionProperties = {
|
|
9
|
+
/**
|
|
10
|
+
* Whether to mark the new version as the latest version.
|
|
11
|
+
*/
|
|
9
12
|
MarkLatest?: boolean;
|
|
10
13
|
/**
|
|
14
|
+
* An owner account.
|
|
11
15
|
* @minLength `1`
|
|
12
16
|
* @maxLength `12`
|
|
13
17
|
* @pattern `^[0-9a-z\_]+$`
|
|
14
18
|
*/
|
|
15
19
|
OwnerAccount?: string;
|
|
16
20
|
/**
|
|
21
|
+
* A package ID.
|
|
17
22
|
* @minLength `1`
|
|
18
23
|
* @maxLength `255`
|
|
19
24
|
* @pattern `^[a-zA-Z0-9\-\_\/]+$`
|
|
20
25
|
*/
|
|
21
26
|
PackageId: string;
|
|
22
27
|
/**
|
|
28
|
+
* A package version.
|
|
23
29
|
* @minLength `1`
|
|
24
30
|
* @maxLength `255`
|
|
25
31
|
* @pattern `^([0-9]+)\.([0-9]+)$`
|
|
26
32
|
*/
|
|
27
33
|
PackageVersion: string;
|
|
28
34
|
/**
|
|
35
|
+
* A patch version.
|
|
29
36
|
* @minLength `1`
|
|
30
37
|
* @maxLength `255`
|
|
31
38
|
* @pattern `^[a-z0-9]+$`
|
|
32
39
|
*/
|
|
33
40
|
PatchVersion: string;
|
|
34
41
|
/**
|
|
42
|
+
* If the version was marked latest, the new version to maker as latest.
|
|
35
43
|
* @minLength `1`
|
|
36
44
|
* @maxLength `255`
|
|
37
45
|
* @pattern `^[a-z0-9]+$`
|
|
@@ -70,7 +78,7 @@ export type PanoramaPackageVersionAttributes = {
|
|
|
70
78
|
export type PackageVersionStatus = "REGISTER_PENDING" | "REGISTER_COMPLETED" | "FAILED" | "DELETING";
|
|
71
79
|
/**
|
|
72
80
|
* Resource type definition for `AWS::Panorama::PackageVersion`.
|
|
73
|
-
*
|
|
81
|
+
* Registers a package version.
|
|
74
82
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-panorama-packageversion.html}
|
|
75
83
|
*/
|
|
76
84
|
export declare class PanoramaPackageVersion extends $Resource<"AWS::Panorama::PackageVersion", PanoramaPackageVersionProperties, PanoramaPackageVersionAttributes> {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
2
|
/**
|
|
3
3
|
* Resource type definition for `AWS::Panorama::PackageVersion`.
|
|
4
|
-
*
|
|
4
|
+
* Registers a package version.
|
|
5
5
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-panorama-packageversion.html}
|
|
6
6
|
*/
|
|
7
7
|
export class PanoramaPackageVersion extends $Resource {
|
|
@@ -5,11 +5,11 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
|
|
|
5
5
|
For more information about creating an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.
|
|
6
6
|
For more information about creating a Multi-AZ DB cluster, see [Creating a Multi-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html) in the *Amazon RDS User Guide*.
|
|
7
7
|
You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported.
|
|
8
|
-
|
|
8
|
+
*Updating DB clusters*
|
|
9
9
|
When properties labeled "*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster.
|
|
10
10
|
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:
|
|
11
11
|
1. Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.
|
|
12
|
-
1. Create a snapshot of the DB cluster. For more information, see [Creating a DB
|
|
12
|
+
1. Create a snapshot of the DB cluster. For more information, see [Creating a DB cluster snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html).
|
|
13
13
|
1. If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the ``SnapshotIdentifier`` property with the ID of the DB cluster snapshot that you want to use.
|
|
14
14
|
After you restore a DB cluster with a ``SnapshotIdentifier`` property, you must specify the same ``SnapshotIdentifier`` property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the DB cluster snapshot again, and the data in the database is not changed. However, if you don't specify the ``SnapshotIdentifier`` property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified ``SnapshotIdentifier`` property, and the original DB cluster is deleted.
|
|
15
15
|
1. Update the stack.
|
|
@@ -43,13 +43,11 @@ export type RDSDBClusterProperties = {
|
|
|
43
43
|
*/
|
|
44
44
|
AvailabilityZones?: string[];
|
|
45
45
|
/**
|
|
46
|
-
* The target backtrack window, in seconds. To disable backtracking, set this value to 0
|
|
47
|
-
|
|
48
|
-
|
|
46
|
+
* The target backtrack window, in seconds. To disable backtracking, set this value to ``0``.
|
|
47
|
+
Valid for Cluster Type: Aurora MySQL DB clusters only
|
|
48
|
+
Default: ``0``
|
|
49
49
|
Constraints:
|
|
50
50
|
+ If specified, this value must be set to a number from 0 to 259,200 (72 hours).
|
|
51
|
-
|
|
52
|
-
Valid for: Aurora MySQL DB clusters only
|
|
53
51
|
* @min `0`
|
|
54
52
|
*/
|
|
55
53
|
BacktrackWindow?: number;
|
|
@@ -408,7 +406,7 @@ export type RDSDBClusterProperties = {
|
|
|
408
406
|
+ ``full-copy`` - The new DB cluster is restored as a full copy of the source DB cluster.
|
|
409
407
|
+ ``copy-on-write`` - The new DB cluster is restored as a clone of the source DB cluster.
|
|
410
408
|
|
|
411
|
-
|
|
409
|
+
If you don't specify a ``RestoreType`` value, then the new DB cluster is restored as a full copy of the source DB cluster.
|
|
412
410
|
Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
413
411
|
*/
|
|
414
412
|
RestoreType?: string;
|
|
@@ -486,8 +484,8 @@ export type RDSDBClusterProperties = {
|
|
|
486
484
|
*/
|
|
487
485
|
StorageType?: string;
|
|
488
486
|
/**
|
|
489
|
-
*
|
|
490
|
-
Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
487
|
+
* Tags to assign to the DB cluster.
|
|
488
|
+
Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
491
489
|
* @maxLength `50`
|
|
492
490
|
*/
|
|
493
491
|
Tags?: Tag[];
|
|
@@ -668,11 +666,11 @@ export type Tag = {
|
|
|
668
666
|
For more information about creating an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.
|
|
669
667
|
For more information about creating a Multi-AZ DB cluster, see [Creating a Multi-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html) in the *Amazon RDS User Guide*.
|
|
670
668
|
You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported.
|
|
671
|
-
|
|
669
|
+
*Updating DB clusters*
|
|
672
670
|
When properties labeled "*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster.
|
|
673
671
|
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:
|
|
674
672
|
1. Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.
|
|
675
|
-
1. Create a snapshot of the DB cluster. For more information, see [Creating a DB
|
|
673
|
+
1. Create a snapshot of the DB cluster. For more information, see [Creating a DB cluster snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html).
|
|
676
674
|
1. If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the ``SnapshotIdentifier`` property with the ID of the DB cluster snapshot that you want to use.
|
|
677
675
|
After you restore a DB cluster with a ``SnapshotIdentifier`` property, you must specify the same ``SnapshotIdentifier`` property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the DB cluster snapshot again, and the data in the database is not changed. However, if you don't specify the ``SnapshotIdentifier`` property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified ``SnapshotIdentifier`` property, and the original DB cluster is deleted.
|
|
678
676
|
1. Update the stack.
|
package/lib/AWS-RDS-DBCluster.js
CHANGED
|
@@ -4,11 +4,11 @@ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/re
|
|
|
4
4
|
For more information about creating an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.
|
|
5
5
|
For more information about creating a Multi-AZ DB cluster, see [Creating a Multi-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html) in the *Amazon RDS User Guide*.
|
|
6
6
|
You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported.
|
|
7
|
-
|
|
7
|
+
*Updating DB clusters*
|
|
8
8
|
When properties labeled "*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster.
|
|
9
9
|
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:
|
|
10
10
|
1. Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.
|
|
11
|
-
1. Create a snapshot of the DB cluster. For more information, see [Creating a DB
|
|
11
|
+
1. Create a snapshot of the DB cluster. For more information, see [Creating a DB cluster snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html).
|
|
12
12
|
1. If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the ``SnapshotIdentifier`` property with the ID of the DB cluster snapshot that you want to use.
|
|
13
13
|
After you restore a DB cluster with a ``SnapshotIdentifier`` property, you must specify the same ``SnapshotIdentifier`` property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the DB cluster snapshot again, and the data in the database is not changed. However, if you don't specify the ``SnapshotIdentifier`` property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified ``SnapshotIdentifier`` property, and the original DB cluster is deleted.
|
|
14
14
|
1. Update the stack.
|
|
@@ -4,7 +4,7 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
|
|
|
4
4
|
* The ``AWS::RDS::DBClusterParameterGroup`` resource creates a new Amazon RDS DB cluster parameter group.
|
|
5
5
|
For information about configuring parameters for Amazon Aurora DB clusters, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
|
|
6
6
|
If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
|
|
7
|
-
If you apply a change to parameter group associated with a stopped DB cluster, then the
|
|
7
|
+
If you apply a change to parameter group associated with a stopped DB cluster, then the updated stack waits until the DB cluster is started.
|
|
8
8
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html}
|
|
9
9
|
*/
|
|
10
10
|
export type RDSDBClusterParameterGroupProperties = {
|
|
@@ -13,22 +13,34 @@ export type RDSDBClusterParameterGroupProperties = {
|
|
|
13
13
|
Constraints:
|
|
14
14
|
+ Must not match the name of an existing DB cluster parameter group.
|
|
15
15
|
|
|
16
|
-
If you don't specify a value for ``DBClusterParameterGroupName`` property, a name is automatically created for the DB cluster parameter group.
|
|
17
16
|
This value is stored as a lowercase string.
|
|
18
17
|
* @pattern `^[a-zA-Z]{1}(?:-?[a-zA-Z0-9])*$`
|
|
19
18
|
*/
|
|
20
19
|
DBClusterParameterGroupName?: string;
|
|
21
20
|
/**
|
|
22
|
-
*
|
|
21
|
+
* The description for the DB cluster parameter group.
|
|
23
22
|
*/
|
|
24
23
|
Description: string;
|
|
25
24
|
/**
|
|
26
|
-
* The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
25
|
+
* The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
|
|
26
|
+
*Aurora MySQL*
|
|
27
|
+
Example: ``aurora-mysql5.7``, ``aurora-mysql8.0``
|
|
28
|
+
*Aurora PostgreSQL*
|
|
29
|
+
Example: ``aurora-postgresql14``
|
|
30
|
+
*RDS for MySQL*
|
|
31
|
+
Example: ``mysql8.0``
|
|
32
|
+
*RDS for PostgreSQL*
|
|
33
|
+
Example: ``postgres13``
|
|
34
|
+
To list all of the available parameter group families for a DB engine, use the following command:
|
|
35
|
+
``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>``
|
|
36
|
+
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
|
|
37
|
+
``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine aurora-postgresql``
|
|
38
|
+
The output contains duplicates.
|
|
39
|
+
The following are the valid DB engine values:
|
|
40
|
+
+ ``aurora-mysql``
|
|
41
|
+
+ ``aurora-postgresql``
|
|
42
|
+
+ ``mysql``
|
|
43
|
+
+ ``postgres``
|
|
32
44
|
*/
|
|
33
45
|
Family: string;
|
|
34
46
|
/**
|
|
@@ -36,7 +48,7 @@ export type RDSDBClusterParameterGroupProperties = {
|
|
|
36
48
|
*/
|
|
37
49
|
Parameters: Record<string, any>;
|
|
38
50
|
/**
|
|
39
|
-
*
|
|
51
|
+
* Tags to assign to the DB cluster parameter group.
|
|
40
52
|
* @maxLength `50`
|
|
41
53
|
*/
|
|
42
54
|
Tags?: Tag[];
|
|
@@ -65,7 +77,7 @@ export type Tag = {
|
|
|
65
77
|
* The ``AWS::RDS::DBClusterParameterGroup`` resource creates a new Amazon RDS DB cluster parameter group.
|
|
66
78
|
For information about configuring parameters for Amazon Aurora DB clusters, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
|
|
67
79
|
If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
|
|
68
|
-
If you apply a change to parameter group associated with a stopped DB cluster, then the
|
|
80
|
+
If you apply a change to parameter group associated with a stopped DB cluster, then the updated stack waits until the DB cluster is started.
|
|
69
81
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html}
|
|
70
82
|
*/
|
|
71
83
|
export declare class RDSDBClusterParameterGroup extends $Resource<"AWS::RDS::DBClusterParameterGroup", RDSDBClusterParameterGroupProperties, Record<string, never>> {
|
|
@@ -3,7 +3,7 @@ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/re
|
|
|
3
3
|
* The ``AWS::RDS::DBClusterParameterGroup`` resource creates a new Amazon RDS DB cluster parameter group.
|
|
4
4
|
For information about configuring parameters for Amazon Aurora DB clusters, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
|
|
5
5
|
If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
|
|
6
|
-
If you apply a change to parameter group associated with a stopped DB cluster, then the
|
|
6
|
+
If you apply a change to parameter group associated with a stopped DB cluster, then the updated stack waits until the DB cluster is started.
|
|
7
7
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html}
|
|
8
8
|
*/
|
|
9
9
|
export class RDSDBClusterParameterGroup extends $Resource {
|
|
@@ -6,7 +6,7 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
|
|
|
6
6
|
For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.
|
|
7
7
|
If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.
|
|
8
8
|
If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html).
|
|
9
|
-
|
|
9
|
+
*Updating DB instances*
|
|
10
10
|
When properties labeled "*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.
|
|
11
11
|
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:
|
|
12
12
|
1. Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
|
|
@@ -156,8 +156,9 @@ export type RDSDBInstanceProperties = {
|
|
|
156
156
|
*/
|
|
157
157
|
CustomIAMInstanceProfile?: string;
|
|
158
158
|
/**
|
|
159
|
-
|
|
160
|
-
|
|
159
|
+
* The identifier of the DB cluster that this DB instance will belong to.
|
|
160
|
+
This setting doesn't apply to RDS Custom DB instances.
|
|
161
|
+
*/
|
|
161
162
|
DBClusterIdentifier?: string;
|
|
162
163
|
/**
|
|
163
164
|
* The identifier for the Multi-AZ DB cluster snapshot to restore from.
|
|
@@ -288,9 +289,8 @@ export type RDSDBInstanceProperties = {
|
|
|
288
289
|
/**
|
|
289
290
|
* A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC.
|
|
290
291
|
If there's no DB subnet group, then the DB instance isn't a VPC DB instance.
|
|
291
|
-
For more information about using Amazon RDS in a VPC, see [
|
|
292
|
-
|
|
293
|
-
Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
|
|
292
|
+
For more information about using Amazon RDS in a VPC, see [Amazon VPC and Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*.
|
|
293
|
+
This setting doesn't apply to Amazon Aurora DB instances. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.
|
|
294
294
|
*/
|
|
295
295
|
DBSubnetGroupName?: string;
|
|
296
296
|
/**
|
|
@@ -304,9 +304,8 @@ export type RDSDBInstanceProperties = {
|
|
|
304
304
|
*/
|
|
305
305
|
DeleteAutomatedBackups?: boolean;
|
|
306
306
|
/**
|
|
307
|
-
*
|
|
308
|
-
|
|
309
|
-
Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
|
|
307
|
+
* Specifies whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection isn't enabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).
|
|
308
|
+
This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.
|
|
310
309
|
*/
|
|
311
310
|
DeletionProtection?: boolean;
|
|
312
311
|
/**
|
|
@@ -516,30 +515,30 @@ export type RDSDBInstanceProperties = {
|
|
|
516
515
|
|
|
517
516
|
*RDS for MariaDB*
|
|
518
517
|
Constraints:
|
|
519
|
-
|
|
518
|
+
+ Must be 1 to 16 letters or numbers.
|
|
520
519
|
+ Can't be a reserved word for the chosen database engine.
|
|
521
520
|
|
|
522
521
|
*RDS for Microsoft SQL Server*
|
|
523
522
|
Constraints:
|
|
524
|
-
|
|
523
|
+
+ Must be 1 to 128 letters or numbers.
|
|
525
524
|
+ First character must be a letter.
|
|
526
525
|
+ Can't be a reserved word for the chosen database engine.
|
|
527
526
|
|
|
528
527
|
*RDS for MySQL*
|
|
529
528
|
Constraints:
|
|
530
|
-
|
|
529
|
+
+ Must be 1 to 16 letters or numbers.
|
|
531
530
|
+ First character must be a letter.
|
|
532
531
|
+ Can't be a reserved word for the chosen database engine.
|
|
533
532
|
|
|
534
533
|
*RDS for Oracle*
|
|
535
534
|
Constraints:
|
|
536
|
-
|
|
535
|
+
+ Must be 1 to 30 letters or numbers.
|
|
537
536
|
+ First character must be a letter.
|
|
538
537
|
+ Can't be a reserved word for the chosen database engine.
|
|
539
538
|
|
|
540
539
|
*RDS for PostgreSQL*
|
|
541
540
|
Constraints:
|
|
542
|
-
|
|
541
|
+
+ Must be 1 to 63 letters or numbers.
|
|
543
542
|
+ First character must be a letter.
|
|
544
543
|
+ Can't be a reserved word for the chosen database engine.
|
|
545
544
|
* @minLength `1`
|
|
@@ -556,10 +555,11 @@ export type RDSDBInstanceProperties = {
|
|
|
556
555
|
*/
|
|
557
556
|
MaxAllocatedStorage?: number;
|
|
558
557
|
/**
|
|
559
|
-
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0
|
|
560
|
-
If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0
|
|
561
|
-
This setting doesn't apply to RDS Custom.
|
|
562
|
-
Valid Values: ``0
|
|
558
|
+
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify ``0``.
|
|
559
|
+
If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than ``0``.
|
|
560
|
+
This setting doesn't apply to RDS Custom DB instances.
|
|
561
|
+
Valid Values: ``0 | 1 | 5 | 10 | 15 | 30 | 60``
|
|
562
|
+
Default: ``0``
|
|
563
563
|
*/
|
|
564
564
|
MonitoringInterval?: number;
|
|
565
565
|
/**
|
|
@@ -569,10 +569,10 @@ export type RDSDBInstanceProperties = {
|
|
|
569
569
|
*/
|
|
570
570
|
MonitoringRoleArn?: string;
|
|
571
571
|
/**
|
|
572
|
-
* Specifies whether the
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
572
|
+
* Specifies whether the DB instance is a Multi-AZ deployment. You can't set the ``AvailabilityZone`` parameter if the DB instance is a Multi-AZ deployment.
|
|
573
|
+
This setting doesn't apply to the following DB instances:
|
|
574
|
+
+ Amazon Aurora (DB instance Availability Zones (AZs) are managed by the DB cluster.)
|
|
575
|
+
+ RDS Custom
|
|
576
576
|
*/
|
|
577
577
|
MultiAZ?: boolean;
|
|
578
578
|
/**
|
|
@@ -616,10 +616,18 @@ export type RDSDBInstanceProperties = {
|
|
|
616
616
|
PerformanceInsightsRetentionPeriod?: number;
|
|
617
617
|
/**
|
|
618
618
|
* The port number on which the database accepts connections.
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
619
|
+
This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster.
|
|
620
|
+
Valid Values: ``1150-65535``
|
|
621
|
+
Default:
|
|
622
|
+
+ RDS for Db2 - ``50000``
|
|
623
|
+
+ RDS for MariaDB - ``3306``
|
|
624
|
+
+ RDS for Microsoft SQL Server - ``1433``
|
|
625
|
+
+ RDS for MySQL - ``3306``
|
|
626
|
+
+ RDS for Oracle - ``1521``
|
|
627
|
+
+ RDS for PostgreSQL - ``5432``
|
|
628
|
+
|
|
629
|
+
Constraints:
|
|
630
|
+
+ For RDS for Microsoft SQL Server, the value can't be ``1234``, ``1434``, ``3260``, ``3343``, ``3389``, ``47001``, or ``49152-49156``.
|
|
623
631
|
* @pattern `^\d*$`
|
|
624
632
|
*/
|
|
625
633
|
Port?: string;
|
|
@@ -737,7 +745,7 @@ export type RDSDBInstanceProperties = {
|
|
|
737
745
|
*/
|
|
738
746
|
StorageType?: string;
|
|
739
747
|
/**
|
|
740
|
-
*
|
|
748
|
+
* Tags to assign to the DB instance.
|
|
741
749
|
*/
|
|
742
750
|
Tags?: Tag[];
|
|
743
751
|
TdeCredentialArn?: string;
|
|
@@ -893,7 +901,7 @@ export type Tag = {
|
|
|
893
901
|
For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.
|
|
894
902
|
If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.
|
|
895
903
|
If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html).
|
|
896
|
-
|
|
904
|
+
*Updating DB instances*
|
|
897
905
|
When properties labeled "*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.
|
|
898
906
|
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:
|
|
899
907
|
1. Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
|
|
@@ -5,7 +5,7 @@ import { Resource as $Resource } from "@awboost/cfn-template-builder/template/re
|
|
|
5
5
|
For more information about creating a DB instance in an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide*.
|
|
6
6
|
If you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.
|
|
7
7
|
If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html).
|
|
8
|
-
|
|
8
|
+
*Updating DB instances*
|
|
9
9
|
When properties labeled "*Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)" are updated, AWS CloudFormation first creates a replacement DB instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.
|
|
10
10
|
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:
|
|
11
11
|
1. Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
|
|
@@ -26,27 +26,39 @@ export type RDSDBParameterGroupProperties = {
|
|
|
26
26
|
*/
|
|
27
27
|
Description: string;
|
|
28
28
|
/**
|
|
29
|
-
* The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
29
|
+
* The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
|
|
30
|
+
To list all of the available parameter group families for a DB engine, use the following command:
|
|
31
|
+
``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>``
|
|
32
|
+
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
|
|
33
|
+
``aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql``
|
|
34
|
+
The output contains duplicates.
|
|
35
|
+
The following are the valid DB engine values:
|
|
36
|
+
+ ``aurora-mysql``
|
|
37
|
+
+ ``aurora-postgresql``
|
|
38
|
+
+ ``db2-ae``
|
|
39
|
+
+ ``db2-se``
|
|
40
|
+
+ ``mysql``
|
|
41
|
+
+ ``oracle-ee``
|
|
42
|
+
+ ``oracle-ee-cdb``
|
|
43
|
+
+ ``oracle-se2``
|
|
44
|
+
+ ``oracle-se2-cdb``
|
|
45
|
+
+ ``postgres``
|
|
46
|
+
+ ``sqlserver-ee``
|
|
47
|
+
+ ``sqlserver-se``
|
|
48
|
+
+ ``sqlserver-ex``
|
|
49
|
+
+ ``sqlserver-web``
|
|
35
50
|
*/
|
|
36
51
|
Family: string;
|
|
37
52
|
/**
|
|
38
|
-
* An array of parameter names and values for the parameter update.
|
|
39
|
-
|
|
40
|
-
For more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.
|
|
41
|
-
For more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
|
|
53
|
+
* An array of parameter names and values for the parameter update. You must specify at least one parameter name and value.
|
|
54
|
+
For more information about parameter groups, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*, or [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide*.
|
|
42
55
|
AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.
|
|
43
56
|
*/
|
|
44
57
|
Parameters?: Record<string, any>;
|
|
45
58
|
/**
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
*/
|
|
59
|
+
* Tags to assign to the DB parameter group.
|
|
60
|
+
* @maxLength `50`
|
|
61
|
+
*/
|
|
50
62
|
Tags?: Tag[];
|
|
51
63
|
};
|
|
52
64
|
/**
|
|
@@ -12,8 +12,12 @@ export type RDSDBSubnetGroupProperties = {
|
|
|
12
12
|
DBSubnetGroupDescription: string;
|
|
13
13
|
/**
|
|
14
14
|
* The name for the DB subnet group. This value is stored as a lowercase string.
|
|
15
|
-
Constraints:
|
|
16
|
-
|
|
15
|
+
Constraints:
|
|
16
|
+
+ Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens.
|
|
17
|
+
+ Must not be default.
|
|
18
|
+
+ First character must be a letter.
|
|
19
|
+
|
|
20
|
+
Example: ``mydbsubnetgroup``
|
|
17
21
|
*/
|
|
18
22
|
DBSubnetGroupName?: string;
|
|
19
23
|
/**
|
|
@@ -21,7 +25,7 @@ export type RDSDBSubnetGroupProperties = {
|
|
|
21
25
|
*/
|
|
22
26
|
SubnetIds: string[];
|
|
23
27
|
/**
|
|
24
|
-
*
|
|
28
|
+
* Tags to assign to the DB subnet group.
|
|
25
29
|
* @maxLength `50`
|
|
26
30
|
*/
|
|
27
31
|
Tags?: Tag[];
|
|
@@ -21,18 +21,19 @@ export type RDSEventSubscriptionProperties = {
|
|
|
21
21
|
/**
|
|
22
22
|
* The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.
|
|
23
23
|
Constraints:
|
|
24
|
-
+ If
|
|
24
|
+
+ If ``SourceIds`` are supplied, ``SourceType`` must also be provided.
|
|
25
25
|
+ If the source type is a DB instance, a ``DBInstanceIdentifier`` value must be supplied.
|
|
26
26
|
+ If the source type is a DB cluster, a ``DBClusterIdentifier`` value must be supplied.
|
|
27
27
|
+ If the source type is a DB parameter group, a ``DBParameterGroupName`` value must be supplied.
|
|
28
28
|
+ If the source type is a DB security group, a ``DBSecurityGroupName`` value must be supplied.
|
|
29
29
|
+ If the source type is a DB snapshot, a ``DBSnapshotIdentifier`` value must be supplied.
|
|
30
30
|
+ If the source type is a DB cluster snapshot, a ``DBClusterSnapshotIdentifier`` value must be supplied.
|
|
31
|
+
+ If the source type is an RDS Proxy, a ``DBProxyName`` value must be supplied.
|
|
31
32
|
*/
|
|
32
33
|
SourceIds?: string[];
|
|
33
34
|
/**
|
|
34
|
-
* The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, set this parameter to ``db-instance``. If this value isn't specified, all events are returned.
|
|
35
|
-
Valid
|
|
35
|
+
* The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you set this parameter to ``db-instance``. For RDS Proxy events, specify ``db-proxy``. If this value isn't specified, all events are returned.
|
|
36
|
+
Valid Values:``db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment``
|
|
36
37
|
*/
|
|
37
38
|
SourceType?: string;
|
|
38
39
|
/**
|
|
@@ -26,7 +26,7 @@ export type RDSOptionGroupProperties = {
|
|
|
26
26
|
*/
|
|
27
27
|
MajorEngineVersion: string;
|
|
28
28
|
/**
|
|
29
|
-
* A list of
|
|
29
|
+
* A list of all available options
|
|
30
30
|
*/
|
|
31
31
|
OptionConfigurations?: OptionConfiguration[];
|
|
32
32
|
/**
|
|
@@ -46,7 +46,7 @@ export type RDSOptionGroupProperties = {
|
|
|
46
46
|
*/
|
|
47
47
|
OptionGroupName?: string;
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
49
|
+
* Tags to assign to the option group.
|
|
50
50
|
*/
|
|
51
51
|
Tags?: Tag[];
|
|
52
52
|
};
|
package/lib/AWS-SNS-Topic.d.ts
CHANGED
|
@@ -25,6 +25,16 @@ export type SNSTopicProperties = {
|
|
|
25
25
|
Length Constraints: Maximum length of 30,720.
|
|
26
26
|
*/
|
|
27
27
|
DataProtectionPolicy?: Record<string, any>;
|
|
28
|
+
/**
|
|
29
|
+
* The ``DeliveryStatusLogging`` configuration enables you to log the delivery status of messages sent from your Amazon SNS topic to subscribed endpoints with the following supported delivery protocols:
|
|
30
|
+
+ HTTP
|
|
31
|
+
+ Amazon Kinesis Data Firehose
|
|
32
|
+
+ AWS Lambda
|
|
33
|
+
+ Platform application endpoint
|
|
34
|
+
+ Amazon Simple Queue Service
|
|
35
|
+
|
|
36
|
+
Once configured, log entries are sent to Amazon CloudWatch Logs.
|
|
37
|
+
*/
|
|
28
38
|
DeliveryStatusLogging?: LoggingConfig[];
|
|
29
39
|
/**
|
|
30
40
|
* The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs.
|
|
@@ -73,12 +83,26 @@ export type SNSTopicAttributes = {
|
|
|
73
83
|
};
|
|
74
84
|
/**
|
|
75
85
|
* Type definition for `AWS::SNS::Topic.LoggingConfig`.
|
|
86
|
+
* The ``LoggingConfig`` property type specifies the ``Delivery`` status logging configuration for an [AWS::SNS::Topic](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html).
|
|
76
87
|
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sns-topic-loggingconfig.html}
|
|
77
88
|
*/
|
|
78
89
|
export type LoggingConfig = {
|
|
90
|
+
/**
|
|
91
|
+
* The IAM role ARN to be used when logging failed message deliveries in Amazon CloudWatch.
|
|
92
|
+
*/
|
|
79
93
|
FailureFeedbackRoleArn?: string;
|
|
94
|
+
/**
|
|
95
|
+
* Indicates one of the supported protocols for the Amazon SNS topic.
|
|
96
|
+
At least one of the other three ``LoggingConfig`` properties is recommend along with ``Protocol``.
|
|
97
|
+
*/
|
|
80
98
|
Protocol: "http/s" | "sqs" | "lambda" | "firehose" | "application";
|
|
99
|
+
/**
|
|
100
|
+
* The IAM role ARN to be used when logging successful message deliveries in Amazon CloudWatch.
|
|
101
|
+
*/
|
|
81
102
|
SuccessFeedbackRoleArn?: string;
|
|
103
|
+
/**
|
|
104
|
+
* The percentage of successful message deliveries to be logged in Amazon CloudWatch. Valid percentage values range from 0 to 100.
|
|
105
|
+
*/
|
|
82
106
|
SuccessFeedbackSampleRate?: string;
|
|
83
107
|
};
|
|
84
108
|
/**
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
|
+
import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
|
|
3
|
+
/**
|
|
4
|
+
* Resource Type definition for AWS::SageMaker::StudioLifecycleConfig
|
|
5
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-studiolifecycleconfig.html}
|
|
6
|
+
*/
|
|
7
|
+
export type SageMakerStudioLifecycleConfigProperties = {
|
|
8
|
+
/**
|
|
9
|
+
* The App type that the Lifecycle Configuration is attached to.
|
|
10
|
+
*/
|
|
11
|
+
StudioLifecycleConfigAppType: "JupyterServer" | "KernelGateway" | "CodeEditor" | "JupyterLab";
|
|
12
|
+
/**
|
|
13
|
+
* The content of your Amazon SageMaker Studio Lifecycle Configuration script.
|
|
14
|
+
* @minLength `1`
|
|
15
|
+
* @maxLength `16384`
|
|
16
|
+
* @pattern `[\S\s]+`
|
|
17
|
+
*/
|
|
18
|
+
StudioLifecycleConfigContent: string;
|
|
19
|
+
/**
|
|
20
|
+
* The name of the Amazon SageMaker Studio Lifecycle Configuration.
|
|
21
|
+
* @minLength `1`
|
|
22
|
+
* @maxLength `63`
|
|
23
|
+
* @pattern `^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}`
|
|
24
|
+
*/
|
|
25
|
+
StudioLifecycleConfigName: string;
|
|
26
|
+
/**
|
|
27
|
+
* Tags to be associated with the Lifecycle Configuration.
|
|
28
|
+
* @minLength `0`
|
|
29
|
+
* @maxLength `50`
|
|
30
|
+
*/
|
|
31
|
+
Tags?: Tag[];
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* Attribute type definition for `AWS::SageMaker::StudioLifecycleConfig`.
|
|
35
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-studiolifecycleconfig.html#aws-resource-sagemaker-studiolifecycleconfig-return-values}
|
|
36
|
+
*/
|
|
37
|
+
export type SageMakerStudioLifecycleConfigAttributes = {
|
|
38
|
+
/**
|
|
39
|
+
* The Amazon Resource Name (ARN) of the Lifecycle Configuration.
|
|
40
|
+
* @minLength `1`
|
|
41
|
+
* @maxLength `256`
|
|
42
|
+
* @pattern `arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:studio-lifecycle-config/.*`
|
|
43
|
+
*/
|
|
44
|
+
StudioLifecycleConfigArn: string;
|
|
45
|
+
};
|
|
46
|
+
/**
|
|
47
|
+
* Type definition for `AWS::SageMaker::StudioLifecycleConfig.Tag`.
|
|
48
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-sagemaker-studiolifecycleconfig-tag.html}
|
|
49
|
+
*/
|
|
50
|
+
export type Tag = {
|
|
51
|
+
/**
|
|
52
|
+
* @minLength `1`
|
|
53
|
+
* @maxLength `128`
|
|
54
|
+
*/
|
|
55
|
+
Key: string;
|
|
56
|
+
/**
|
|
57
|
+
* @minLength `1`
|
|
58
|
+
* @maxLength `128`
|
|
59
|
+
*/
|
|
60
|
+
Value: string;
|
|
61
|
+
};
|
|
62
|
+
/**
|
|
63
|
+
* Resource Type definition for AWS::SageMaker::StudioLifecycleConfig
|
|
64
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-studiolifecycleconfig.html}
|
|
65
|
+
*/
|
|
66
|
+
export declare class SageMakerStudioLifecycleConfig extends $Resource<"AWS::SageMaker::StudioLifecycleConfig", SageMakerStudioLifecycleConfigProperties, SageMakerStudioLifecycleConfigAttributes> {
|
|
67
|
+
static readonly Type = "AWS::SageMaker::StudioLifecycleConfig";
|
|
68
|
+
constructor(logicalId: string, properties: SageMakerStudioLifecycleConfigProperties, options?: $ResourceOptions);
|
|
69
|
+
}
|
|
70
|
+
//# sourceMappingURL=AWS-SageMaker-StudioLifecycleConfig.d.ts.map
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
|
|
2
|
+
/**
|
|
3
|
+
* Resource Type definition for AWS::SageMaker::StudioLifecycleConfig
|
|
4
|
+
* @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sagemaker-studiolifecycleconfig.html}
|
|
5
|
+
*/
|
|
6
|
+
export class SageMakerStudioLifecycleConfig extends $Resource {
|
|
7
|
+
static Type = "AWS::SageMaker::StudioLifecycleConfig";
|
|
8
|
+
constructor(logicalId, properties, options) {
|
|
9
|
+
super(logicalId, SageMakerStudioLifecycleConfig.Type, properties, options);
|
|
10
|
+
}
|
|
11
|
+
}
|
|
12
|
+
//# sourceMappingURL=AWS-SageMaker-StudioLifecycleConfig.js.map
|