View a markdown version of this page

AWS::ControlTower::EnabledBaseline - Amazon CloudFormation
SyntaxPropertiesReturn values
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::ControlTower::EnabledBaseline

The resource represents an enabled baseline. It specifies an asynchronous operation that applies a baseline to the specified target. For more information, see Types of baselines.

Syntax

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

JSON

{
  "Type" : "AWS::ControlTower::EnabledBaseline",
  "Properties" : {
      "BaselineIdentifier" : String,
      "BaselineVersion" : String,
      "Parameters" : [ Parameter, ... ],
      "Tags" : [ Tag, ... ],
      "TargetIdentifier" : String
    }
}

YAML

Type: AWS::ControlTower::EnabledBaseline
Properties:
  BaselineIdentifier: String
  BaselineVersion: String
  Parameters: 
    - Parameter
  Tags: 
    - Tag
  TargetIdentifier: String

Properties

BaselineIdentifier

The specific Baseline enabled as part of the EnabledBaseline resource.

Required: Yes

Type: String

Pattern: ^arn:aws[0-9a-zA-Z_\-:\/]+$

Minimum: 20

Maximum: 2048

Update requires: Replacement

BaselineVersion

The enabled version of the Baseline.

Required: Yes

Type: String

Pattern: ^\d+(?:\.\d+){0,2}$

Update requires: No interruption

Parameters

Shows the parameters that are applied when enabling this Baseline.

Required: No

Type: Array of Parameter

Update requires: No interruption

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

Update requires: No interruption

TargetIdentifier

The target on which to enable the Baseline.

Required: Yes

Type: String

Pattern: ^arn:aws[0-9a-zA-Z_\-:\/]+$

Minimum: 20

Maximum: 2048

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the enabled baseline identifier. For example:

arn:aws:controltower:us-west-2:123456789012:enabledbaseline/AB12CD34EF56GH789

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type.

EnabledBaselineIdentifier

The unique identifier of the enabled baseline.