aws-cdk-lib.aws_ec2.CfnSqlHaStandbyDetectedInstanceProps

CfnSqlHaStandbyDetectedInstanceProps Struct

Properties for defining a CfnSqlHaStandbyDetectedInstance.

Source

Generated code

Type last changed

v2.247.0 · 2 Apr 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnSqlHaStandbyDetectedInstanceProps: ec2.CfnSqlHaStandbyDetectedInstanceProps = {
  instanceId: 'instanceId',

  // the properties below are optional
  sqlServerCredentials: 'sqlServerCredentials',
};

Properties

instanceIdstringinstance_idstrinstanceIdStringInstanceIdstringInstanceId*stringrequired#

The ID of the EC2 instance to enable for SQL Server high availability standby detection.

sqlServerCredentialsstringsql_server_credentialsstrsqlServerCredentialsStringSqlServerCredentialsstringSqlServerCredentials*string#

The ARN of the AWS Secrets Manager secret containing SQL Server access credentials to the EC2 instance.

If not specified, AWS Systems Manager agent will use default local user credentials.

Used as props by

• CfnSqlHaStandbyDetectedInstance