landing_zones

Creates, updates, deletes or gets a landing_zone resource or lists landing_zones in a region

Overview

Name	landing_zones
Type	Resource
Description	Definition of AWS::ControlTower::LandingZone Resource Type
Id	aws.controltower.landing_zones

Fields

Name	Datatype	Description
landing_zone_identifier	string
arn	string
status	string
latest_available_version	string
drift_status	string
manifest
version	string
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Manifest, Version, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all landing_zones in a region.

SELECT
region,
landing_zone_identifier,
arn,
status,
latest_available_version,
drift_status,
manifest,
version,
tags
FROM aws.controltower.landing_zones
WHERE region = 'us-east-1';

Gets all properties from an individual landing_zone.

SELECT
region,
landing_zone_identifier,
arn,
status,
latest_available_version,
drift_status,
manifest,
version,
tags
FROM aws.controltower.landing_zones
WHERE region = 'us-east-1' AND data__Identifier = '<LandingZoneIdentifier>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.controltower.landing_zones (
 Manifest,
 Version,
 region
)
SELECT 
'{{ Manifest }}',
 '{{ Version }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.controltower.landing_zones (
 Manifest,
 Version,
 Tags,
 region
)
SELECT 
 '{{ Manifest }}',
 '{{ Version }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: landing_zone
    props:
      - name: Manifest
        value: null
      - name: Version
        value: '{{ Version }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.controltower.landing_zones
WHERE data__Identifier = '<LandingZoneIdentifier>'
AND region = 'us-east-1';

Permissions

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

Create

controltower:CreateLandingZone,
controltower:GetLandingZoneOperation,
controltower:ListTagsForResource,
controltower:TagResource,
controltower:GetLandingZone,
cloudformation:DescribeOrganizationsAccess,
servicecatalog:AssociatePrincipalWithPortfolio,
servicecatalog:AssociateProductWithPortfolio,
servicecatalog:CreatePortfolio,
servicecatalog:CreateProduct,
servicecatalog:CreateProvisioningArtifact,
servicecatalog:ListPortfolios,
servicecatalog:ListProvisioningArtifacts,
servicecatalog:SearchProductsAsAdmin,
servicecatalog:UpdatePortfolio,
servicecatalog:UpdateProvisioningArtifact,
servicecatalog:ListPrincipalsForPortfolio,
organizations:CreateOrganizationalUnit,
organizations:CreateOrganization,
organizations:UpdatePolicy,
organizations:CreatePolicy,
organizations:AttachPolicy,
organizations:DetachPolicy,
organizations:DeletePolicy,
organizations:EnablePolicyType,
organizations:EnableAWSServiceAccess,
organizations:ListRoots,
sso:GetPeregrineStatus,
sso:ListDirectoryAssociations,
sso:StartPeregrine,
sso:RegisterRegion

Read

controltower:GetLandingZone,
controltower:ListTagsForResource

Update

controltower:UpdateLandingZone,
controltower:GetLandingZoneOperation,
controltower:ListTagsForResource,
controltower:TagResource,
controltower:GetLandingZone,
controltower:UntagResource,
cloudformation:DescribeOrganizationsAccess,
servicecatalog:AssociatePrincipalWithPortfolio,
servicecatalog:AssociateProductWithPortfolio,
servicecatalog:CreatePortfolio,
servicecatalog:CreateProduct,
servicecatalog:CreateProvisioningArtifact,
servicecatalog:ListPortfolios,
servicecatalog:ListProvisioningArtifacts,
servicecatalog:SearchProductsAsAdmin,
servicecatalog:UpdatePortfolio,
servicecatalog:UpdateProvisioningArtifact,
servicecatalog:ListPrincipalsForPortfolio,
organizations:CreateOrganizationalUnit,
organizations:CreateOrganization,
organizations:UpdatePolicy,
organizations:CreatePolicy,
organizations:AttachPolicy,
organizations:DetachPolicy,
organizations:DeletePolicy,
organizations:EnablePolicyType,
organizations:EnableAWSServiceAccess,
organizations:ListRoots,
sso:GetPeregrineStatus,
sso:ListDirectoryAssociations,
sso:StartPeregrine,
sso:RegisterRegion

Delete

controltower:DeleteLandingZone,
controltower:GetLandingZone,
controltower:GetLandingZoneOperation,
cloudformation:DescribeOrganizationsAccess,
servicecatalog:ListPortfolios,
servicecatalog:ListProvisioningArtifacts,
servicecatalog:SearchProductsAsAdmin,
servicecatalog:DeleteProvisioningArtifact,
servicecatalog:ListPrincipalsForPortfolio,
servicecatalog:DeleteProduct,
servicecatalog:DisassociatePrincipalFromPortfolio,
servicecatalog:DisassociateProductFromPortfolio,
servicecatalog:DeletePortfolio,
organizations:AttachPolicy,
organizations:DetachPolicy,
organizations:DeletePolicy,
organizations:ListRoots,
sso:GetPeregrineStatus,
sso:ListDirectoryAssociations,
iam:DeleteRolePolicy,
iam:DetachRolePolicy,
iam:DeleteRole

List

controltower:ListLandingZones