View a markdown version of this page

AWS::WorkSpaces::Directory CertificateBasedAuthProperties - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::WorkSpaces::Directory CertificateBasedAuthProperties

Describes the properties of the certificate-based authentication you want to use with your WorkSpaces.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "CertificateAuthorityArn" : String,
  "Status" : String
}

YAML

  CertificateAuthorityArn: String
  Status: String

Properties

CertificateAuthorityArn

The Amazon Resource Name (ARN) of the Amazon Certificate Manager Private CA resource.

Required: No

Type: String

Pattern: ^arn:[\w+=/,.@-]+:[\w+=/,.@-]+:[\w+=/,.@-]*:[0-9]*:[\w+=,.@-]+(/[\w+=,.@-]+)*$

Minimum: 5

Maximum: 200

Update requires: No interruption

Status

The status of the certificate-based authentication properties.

Required: No

Type: String

Allowed values: DISABLED | ENABLED

Update requires: No interruption