Skip to main content

landing_zones

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

Overview​

Namelanding_zones
TypeResource
DescriptionDefinition of AWS::ControlTower::LandingZone Resource Type
Idawscc.controltower.landing_zones

Fields​

NameDatatypeDescription
statusstring
latest_available_versionstring
versionstring
drift_statusstring
arnstring
manifestobject
landing_zone_identifierstring
▶tagsarray
regionstringAWS region.

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

Methods​

NameResourceAccessible byRequired Params
create_resourcelanding_zonesINSERTManifest, Version, region
delete_resourcelanding_zonesDELETEIdentifier, region
update_resourcelanding_zonesUPDATEIdentifier, PatchDocument, region
list_resourceslanding_zones_list_onlySELECTregion
get_resourcelanding_zonesSELECTIdentifier, region

SELECT examples​

Gets all properties from an individual landing_zone.

SELECT
  region,
  status,
  latest_available_version,
  version,
  drift_status,
  arn,
  manifest,
  landing_zone_identifier,
  tags
FROM awscc.controltower.landing_zones
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ landing_zone_identifier }}';

INSERT example​

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

/*+ create */
INSERT INTO awscc.controltower.landing_zones (
  Version,
  Manifest,
  region
)
SELECT
  '{{ version }}',
  '{{ manifest }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

UPDATE example​

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

/*+ update */
UPDATE awscc.controltower.landing_zones
SET PatchDocument = string('{{ {
    "Version": version,
    "Manifest": manifest,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ landing_zone_identifier }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example​

/*+ delete */
DELETE FROM awscc.controltower.landing_zones
WHERE
  Identifier = '{{ landing_zone_identifier }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters​

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

ParameterDescription
ClientToken
A unique identifier to ensure the idempotency of the resource request.This allows the provider to accurately distinguish between retries and new requests.
A client token is valid for 36 hours once used.
After that, a resource request with the same client token is treated as a new request.
If you do not specify a client token, one is generated for inclusion in the request.
RoleArn
The ARN of the IAM role used to perform this resource operation.The role specified must have the permissions required for this operation.
If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId
For private resource types, the type version to use in this resource operation.If you do not specify a resource version, the default version is used.

Permissions​

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

controltower:GetLandingZone,
controltower:ListTagsForResource