Skip to content

Commit 058ca99

Browse files
Update generated code (#1780)
update generated code
1 parent 6c30b3e commit 058ca99

8 files changed

+30
-22
lines changed

CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
## NOT RELEASED
44

5+
### Changed
6+
7+
- AWS enhancement: Documentation updates.
8+
59
## 1.7.1
610

711
### Changed

src/CloudFormationClient.php

+5-5
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ class CloudFormationClient extends AbstractApi
2121
* Returns information about a stack drift detection operation. A stack drift detection operation detects whether a
2222
* stack's actual configuration differs, or has *drifted*, from its expected configuration, as defined in the stack
2323
* template and any values specified as template parameters. A stack is considered to have drifted if one or more of its
24-
* resources have drifted. For more information about stack and resource drift, see Detecting Unregulated Configuration
25-
* Changes to Stacks and Resources [^1].
24+
* resources have drifted. For more information about stack and resource drift, see Detect unmanaged configuration
25+
* changes to stacks and resources with drift detection [^1].
2626
*
2727
* Use DetectStackDrift to initiate a stack drift detection operation. `DetectStackDrift` returns a
2828
* `StackDriftDetectionId` you can use to monitor the progress of the operation using
@@ -49,7 +49,7 @@ public function describeStackDriftDetectionStatus($input): DescribeStackDriftDet
4949

5050
/**
5151
* Returns all stack related events for a specified stack in reverse chronological order. For more information about a
52-
* stack's event history, see CloudFormation stack creation events [^1] in the *CloudFormation User Guide*.
52+
* stack's event history, see Understand CloudFormation stack creation events [^1] in the *CloudFormation User Guide*.
5353
*
5454
* > You can list events for stacks that have failed to create or have been deleted by specifying the unique stack
5555
* > identifier (stack ID).
@@ -75,8 +75,8 @@ public function describeStackEvents($input = []): DescribeStackEventsOutput
7575

7676
/**
7777
* Returns the description for the specified stack; if no stack name was specified, then it returns the description for
78-
* all the stacks created. For more information about a stack's event history, see CloudFormation stack creation events
79-
* [^1] in the *CloudFormation User Guide*.
78+
* all the stacks created. For more information about a stack's event history, see Understand CloudFormation stack
79+
* creation events [^1] in the *CloudFormation User Guide*.
8080
*
8181
* > If the stack doesn't exist, a `ValidationError` is returned.
8282
*

src/ValueObject/Parameter.php

+4-3
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,11 @@ final class Parameter
3131
private $usePreviousValue;
3232

3333
/**
34-
* Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM [^1] parameter
35-
* types in the template.
34+
* Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for Systems
35+
* Manager parameter types in the template. For more information, see Use CloudFormation-supplied parameter types [^1]
36+
* in the *CloudFormation User Guide*.
3637
*
37-
* [^1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types
38+
* [^1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-supplied-parameter-types.html
3839
*
3940
* @var string|null
4041
*/

src/ValueObject/RollbackConfiguration.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
*
99
* Rollback triggers enable you to have CloudFormation monitor the state of your application during stack creation and
1010
* updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've
11-
* specified. For more information, see Monitor and Roll Back Stack Operations [^1].
11+
* specified. For more information, see Roll back your CloudFormation stack on alarm breach with rollback triggers [^1].
1212
*
1313
* [^1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html
1414
*/

src/ValueObject/RollbackTrigger.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ final class RollbackTrigger
2424
* The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm [^1] or
2525
* AWS::CloudWatch::CompositeAlarm [^2] resource types.
2626
*
27-
* [^1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html
27+
* [^1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarm.html
2828
* [^2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-compositealarm.html
2929
*
3030
* @var string

src/ValueObject/Stack.php

+11-8
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,8 @@ final class Stack
130130
private $outputs;
131131

132132
/**
133-
* The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that's associated with the stack.
134-
* During a stack operation, CloudFormation uses this role's credentials to make calls on your behalf.
133+
* The Amazon Resource Name (ARN) of an IAM role that's associated with the stack. During a stack operation,
134+
* CloudFormation uses this role's credentials to make calls on your behalf.
135135
*
136136
* @var string|null
137137
*/
@@ -148,7 +148,8 @@ final class Stack
148148
* Whether termination protection is enabled for the stack.
149149
*
150150
* For nested stacks [^1], termination protection is set on the root stack and can't be changed directly on the nested
151-
* stack. For more information, see Protecting a Stack From Being Deleted [^2] in the *CloudFormation User Guide*.
151+
* stack. For more information, see Protect a CloudFormation stack from being deleted [^2] in the *CloudFormation User
152+
* Guide*.
152153
*
153154
* [^1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
154155
* [^2]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html
@@ -161,7 +162,8 @@ final class Stack
161162
* For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack.
162163
* For the first level of nested stacks, the root stack is also the parent stack.
163164
*
164-
* For more information, see Working with Nested Stacks [^1] in the *CloudFormation User Guide*.
165+
* For more information, see Embed stacks within other stacks using nested stacks [^1] in the *CloudFormation User
166+
* Guide*.
165167
*
166168
* [^1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
167169
*
@@ -173,7 +175,8 @@ final class Stack
173175
* For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which the
174176
* nested stack ultimately belongs.
175177
*
176-
* For more information, see Working with Nested Stacks [^1] in the *CloudFormation User Guide*.
178+
* For more information, see Embed stacks within other stacks using nested stacks [^1] in the *CloudFormation User
179+
* Guide*.
177180
*
178181
* [^1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html
179182
*
@@ -183,8 +186,8 @@ final class Stack
183186

184187
/**
185188
* Information about whether a stack's actual configuration differs, or has *drifted*, from its expected configuration,
186-
* as defined in the stack template and any values specified as template parameters. For more information, see Detecting
187-
* Unregulated Configuration Changes to Stacks and Resources [^1].
189+
* as defined in the stack template and any values specified as template parameters. For more information, see Detect
190+
* unmanaged configuration changes to stacks and resources with drift detection [^1].
188191
*
189192
* [^1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html
190193
*
@@ -216,7 +219,7 @@ final class Stack
216219
* The detailed status of the resource or stack. If `CONFIGURATION_COMPLETE` is present, the resource or resource
217220
* configuration phase has completed and the stabilization of the resources is in progress. The stack sets
218221
* `CONFIGURATION_COMPLETE` when all of the resources in the stack have reached that event. For more information, see
219-
* CloudFormation stack deployment [^1] in the *CloudFormation User Guide*.
222+
* Understand CloudFormation stack creation events [^1] in the *CloudFormation User Guide*.
220223
*
221224
* [^1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html
222225
*

src/ValueObject/StackEvent.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ final class StackEvent
5050
private $physicalResourceId;
5151

5252
/**
53-
* Type of resource. (For more information, go to Amazon Web Services Resource Types Reference [^1] in the
54-
* *CloudFormation User Guide*.).
53+
* Type of resource. For more information, see Amazon Web Services resource and property types reference [^1] in the
54+
* *CloudFormation User Guide*.
5555
*
5656
* [^1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
5757
*
@@ -145,7 +145,7 @@ final class StackEvent
145145
* An optional field containing information about the detailed status of the stack event.
146146
*
147147
* - `CONFIGURATION_COMPLETE` - all of the resources in the stack have reached that event. For more information, see
148-
* CloudFormation stack deployment [^1] in the *CloudFormation User Guide*.
148+
* Understand CloudFormation stack creation events [^1] in the *CloudFormation User Guide*.
149149
*
150150
* - `VALIDATION_FAILED` - template validation failed because of invalid properties in the template. The
151151
* `ResourceStatusReason` field shows what properties are defined incorrectly.

src/ValueObject/Tag.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ final class Tag
1212
{
1313
/**
1414
* *Required*. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned
15-
* by Amazon Web Services (Amazon Web Services) have the reserved prefix: `aws:`.
15+
* by Amazon Web Services have the reserved prefix: `aws:`.
1616
*
1717
* @var string
1818
*/

0 commit comments

Comments
 (0)