enabled_baselines

Creates, updates, deletes or gets an enabled_baseline resource or lists enabled_baselines in a region

Overview

Name	enabled_baselines
Type	Resource
Description	Definition of AWS::ControlTower::EnabledBaseline Resource Type
Id	awscc.controltower.enabled_baselines

Fields

get (all properties)

Name	Datatype	Description
baseline_identifier	string
baseline_version	string
enabled_baseline_identifier	string
target_identifier	string
▶parameters	array
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
baseline_identifier	string
enabled_baseline_identifier	string
region	string	AWS region.

For more information, see AWS::ControlTower::EnabledBaseline.

Methods

Name	Resource	Accessible by	Required Params
create_resource	enabled_baselines	INSERT	BaselineIdentifier, TargetIdentifier, BaselineVersion, region
delete_resource	enabled_baselines	DELETE	Identifier, region
update_resource	enabled_baselines	UPDATE	Identifier, PatchDocument, region
list_resources	enabled_baselines_list_only	SELECT	region
get_resource	enabled_baselines	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual enabled_baseline.

SELECT
  region,
  baseline_identifier,
  baseline_version,
  enabled_baseline_identifier,
  target_identifier,
  parameters,
  tags
FROM awscc.controltower.enabled_baselines
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ enabled_baseline_identifier }}';

list (identifiers only)

Lists all enabled_baselines in a region.

SELECT
  region,
  enabled_baseline_identifier
FROM awscc.controltower.enabled_baselines_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new enabled_baseline resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.controltower.enabled_baselines (
  BaselineIdentifier,
  BaselineVersion,
  TargetIdentifier,
  region
)
SELECT
  '{{ baseline_identifier }}',
  '{{ baseline_version }}',
  '{{ target_identifier }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.controltower.enabled_baselines (
  BaselineIdentifier,
  BaselineVersion,
  TargetIdentifier,
  Parameters,
  Tags,
  region
)
SELECT
  '{{ baseline_identifier }}',
  '{{ baseline_version }}',
  '{{ target_identifier }}',
  '{{ parameters }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: enabled_baseline
    props:
      - name: baseline_identifier
        value: '{{ baseline_identifier }}'
      - name: baseline_version
        value: '{{ baseline_version }}'
      - name: target_identifier
        value: '{{ target_identifier }}'
      - name: parameters
        value:
          - key: '{{ key }}'
            value: null
      - name: tags
        value:
          - value: '{{ value }}'
            key: '{{ key }}'

UPDATE example

Use the following StackQL query and manifest file to update a enabled_baseline resource, using stack-deploy.

/*+ update */
UPDATE awscc.controltower.enabled_baselines
SET PatchDocument = string('{{ {
    "BaselineVersion": baseline_version,
    "Parameters": parameters,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ enabled_baseline_identifier }}';

DELETE example

/*+ delete */
DELETE FROM awscc.controltower.enabled_baselines
WHERE
  Identifier = '{{ enabled_baseline_identifier }}' AND
  region = 'us-east-1';

Permissions

To operate on the enabled_baselines resource, the following permissions are required:

Create

controltower:EnableBaseline,
controltower:TagResource,
controltower:UntagResource,
controltower:GetBaselineOperation,
controltower:GetEnabledBaseline,
controltower:ListTagsForResource,
organizations:CreateOrganizationalUnit,
organizations:CreateOrganization,
organizations:UpdatePolicy,
organizations:CreatePolicy,
organizations:AttachPolicy,
organizations:DetachPolicy,
organizations:DeletePolicy,
organizations:EnablePolicyType,
organizations:EnableAWSServiceAccess,
organizations:ListRoots,
servicecatalog:AssociatePrincipalWithPortfolio,
servicecatalog:AssociateProductWithPortfolio,
servicecatalog:CreatePortfolio,
servicecatalog:CreateProduct,
servicecatalog:CreateProvisioningArtifact,
servicecatalog:ListPortfolios,
servicecatalog:ListProvisioningArtifacts,
servicecatalog:SearchProductsAsAdmin,
servicecatalog:UpdatePortfolio,
servicecatalog:UpdateProvisioningArtifact,
servicecatalog:ListPrincipalsForPortfolio,
servicecatalog:DeleteProvisioningArtifact

Read

controltower:GetEnabledBaseline,
controltower:ListEnabledBaselines,
controltower:ListTagsForResource

Update

controltower:UpdateEnabledBaseline,
controltower:GetBaselineOperation,
organizations:CreateOrganizationalUnit,
organizations:CreateOrganization,
organizations:UpdatePolicy,
organizations:CreatePolicy,
organizations:AttachPolicy,
organizations:DetachPolicy,
organizations:DeletePolicy,
organizations:EnablePolicyType,
organizations:EnableAWSServiceAccess,
organizations:ListRoots,
servicecatalog:AssociatePrincipalWithPortfolio,
servicecatalog:AssociateProductWithPortfolio,
servicecatalog:CreatePortfolio,
servicecatalog:CreateProduct,
servicecatalog:CreateProvisioningArtifact,
servicecatalog:ListPortfolios,
servicecatalog:ListProvisioningArtifacts,
servicecatalog:SearchProductsAsAdmin,
servicecatalog:UpdatePortfolio,
servicecatalog:UpdateProvisioningArtifact,
servicecatalog:ListPrincipalsForPortfolio,
servicecatalog:DeleteProvisioningArtifact,
controltower:TagResource,
controltower:UntagResource,
controltower:GetEnabledBaseline

Delete

controltower:DisableBaseline,
controltower:GetBaselineOperation,
organizations:CreateOrganizationalUnit,
organizations:CreateOrganization,
organizations:UpdatePolicy,
organizations:CreatePolicy,
organizations:AttachPolicy,
organizations:DetachPolicy,
organizations:DeletePolicy,
organizations:EnablePolicyType,
organizations:EnableAWSServiceAccess,
organizations:ListRoots,
servicecatalog:AssociatePrincipalWithPortfolio,
servicecatalog:AssociateProductWithPortfolio,
servicecatalog:CreatePortfolio,
servicecatalog:CreateProduct,
servicecatalog:CreateProvisioningArtifact,
servicecatalog:ListPortfolios,
servicecatalog:ListProvisioningArtifacts,
servicecatalog:SearchProductsAsAdmin,
servicecatalog:UpdatePortfolio,
servicecatalog:UpdateProvisioningArtifact,
servicecatalog:ListPrincipalsForPortfolio,
servicecatalog:DeleteProvisioningArtifact

List

controltower:ListEnabledBaselines