AWS AWSCloudFormation documentation change
Summary
Added comprehensive documentation for the AWS::EC2::SqlHaStandbyDetectedInstance resource, including detailed property descriptions, return values, and usage examples for SQL Server High Availability standby detection monitoring.
Security assessment
This change documents a new CloudFormation resource for SQL Server High Availability monitoring. It includes security-relevant information about using AWS Secrets Manager for SQL Server access credentials (SecretArn property) and mentions prerequisites including Systems Manager agent installation. While it adds security documentation about credential management, there's no evidence it addresses a specific security vulnerability.
Diff
diff --git a/AWSCloudFormation/latest/TemplateReference/aws-resource-ec2-sqlhastandbydetectedinstance.md b/AWSCloudFormation/latest/TemplateReference/aws-resource-ec2-sqlhastandbydetectedinstance.md index efafd344d..48a7c769c 100644 --- a//AWSCloudFormation/latest/TemplateReference/aws-resource-ec2-sqlhastandbydetectedinstance.md +++ b//AWSCloudFormation/latest/TemplateReference/aws-resource-ec2-sqlhastandbydetectedinstance.md @@ -9 +9,3 @@ This is the new _CloudFormation Template Reference Guide_. Please update your bo -The `AWS::EC2::SqlHaStandbyDetectedInstance` resource Property description not available. for EC2. +Specifies an Amazon EC2 instance for SQL Server High Availability standby detection monitoring. Once enabled, AWS monitors the metadata for the instance to determine whether it is an active or standby node in a SQL Server High Availability cluster. If the instance is determined to be a standby failover node, AWS automatically applies SQL Server licensing fee waiver for this instance. + +To register an instance, it must be running a Windows SQL Server license-included AMI and have the AWS Systems Manager agent installed and running. Only Windows Server 2019 and later and SQL Server (Standard and Enterprise editions) 2017 and later are supported. For more information, see [ Prerequisites for using SQL Server High Availability instance standby detection](https://docs.aws.amazon.com/sql-server-ec2/latest/userguide/prerequisites-and-requirements.html). @@ -41 +43 @@ To declare this entity in your CloudFormation template, use the following syntax -Property description not available. +The ID of the SQL Server High Availability instance. @@ -54 +56 @@ _Update requires_ : [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/ -Property description not available. +The ARN of the AWS Secrets Manager secret containing the SQL Server access credentials for the SQL Server High Availability instance. If not specified, deafult local user credentials will be used by the AWS Systems Manager agent. @@ -67,0 +70,4 @@ _Update requires_ : [No interruption](https://docs.aws.amazon.com/AWSCloudFormat +When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the SQL Server High Availability instance. + +For more information about using the `Ref` function, see [`Ref`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). + @@ -69,0 +76,4 @@ _Update requires_ : [No interruption](https://docs.aws.amazon.com/AWSCloudFormat +The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. + +For more information about using the `Fn::GetAtt` intrinsic function, see [`Fn::GetAtt`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). + @@ -75 +85,12 @@ _Update requires_ : [No interruption](https://docs.aws.amazon.com/AWSCloudFormat -Property description not available. +The SQL Server High Availability status of the instance. Valid values are: + + * `processing` \- The SQL Server High Availability status for the SQL Server High Availability instance is being updated. + + * `active` \- The SQL Server High Availability instance is an active node in an SQL Server High Availability cluster. + + * `standby` \- The SQL Server High Availability instance is a standby failover node in an SQL Server High Availability cluster. + + * `invalid` \- An error occurred due to misconfigured permissions, or unable to dertemine SQL Server High Availability status for the SQL Server High Availability instance. + + + @@ -80 +101 @@ Property description not available. -Property description not available. +The date and time when the instance's SQL Server High Availability status was last updated, in the ISO 8601 format in the UTC time zone (`YYYY-MM-DDThh:mm:ss.sssZ`). @@ -85 +106,8 @@ Property description not available. -Property description not available. +The license type for the SQL Server license. Valid values include: + + * `full` \- The SQL Server High Availability instance is using a full SQL Server license. + + * `waived` \- The SQL Server High Availability instance is waived from the SQL Server license. + + +