Class: AWS.ControlTower
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.ControlTower
- Identifier:
- controltower
- API Version:
- 2018-05-10
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
These interfaces allow you to apply the Amazon Web Services library of pre-defined controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms "control" and "guardrail" are synonyms.
To call these APIs, you'll need to know:
-
the
controlIdentifier
for the control--or guardrail--you are targeting. -
the ARN associated with the target organizational unit (OU), which we call the
targetIdentifier
. -
the ARN associated with a resource that you wish to tag or untag.
To get the controlIdentifier
for your Amazon Web Services Control Tower control:
The controlIdentifier
is an ARN that is specified for each control. You can view the controlIdentifier
in the console on the Control details page, as well as in the documentation.
The controlIdentifier
is unique in each Amazon Web Services Region for each control. You can find the controlIdentifier
for each Region and control in the Tables of control metadata in the Amazon Web Services Control Tower User Guide.
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and controls in the Controls reference guide section of the Amazon Web Services Control Tower User Guide. Remember that Mandatory controls cannot be added or removed.
arn:aws:controltower:[REGION]::control/[CONTROL_NAME]
Example: arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
To get the targetIdentifier
:
The targetIdentifier
is the ARN for an OU.
In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.
arn:$[Partition]:organizations::$[MasterAccountId]:ou/o-$[OrganizationId]/ou-$[OrganizationalUnitId]
Details and examples
To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
Recording API Requests
Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.
Sending a Request Using ControlTower
var controltower = new AWS.ControlTower();
controltower.createLandingZone(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the ControlTower object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var controltower = new AWS.ControlTower({apiVersion: '2018-05-10'});
You can also set the API version globally in AWS.config.apiVersions
using
the controltower service identifier:
AWS.config.apiVersions = {
controltower: '2018-05-10',
// other service API versions
};
var controltower = new AWS.ControlTower();
Constructor Summary collapse
-
new AWS.ControlTower(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
createLandingZone(params = {}, callback) ⇒ AWS.Request
Creates a new landing zone.
-
deleteLandingZone(params = {}, callback) ⇒ AWS.Request
Decommissions a landing zone.
-
disableBaseline(params = {}, callback) ⇒ AWS.Request
Disable an
EnabledBaseline
resource on the specified Target. -
disableControl(params = {}, callback) ⇒ AWS.Request
This API call turns off a control.
-
enableBaseline(params = {}, callback) ⇒ AWS.Request
Enable (apply) a
Baseline
to a Target. -
enableControl(params = {}, callback) ⇒ AWS.Request
This API call activates a control.
-
getBaseline(params = {}, callback) ⇒ AWS.Request
Retrieve details about an existing
Baseline
resource by specifying its identifier..
-
getBaselineOperation(params = {}, callback) ⇒ AWS.Request
Returns the details of an asynchronous baseline operation, as initiated by any of these APIs:
EnableBaseline
,DisableBaseline
,UpdateEnabledBaseline
,ResetEnabledBaseline
. -
getControlOperation(params = {}, callback) ⇒ AWS.Request
Returns the status of a particular
EnableControl
orDisableControl
operation. -
getEnabledBaseline(params = {}, callback) ⇒ AWS.Request
Retrieve details of an
EnabledBaseline
resource by specifying its identifier..
-
getEnabledControl(params = {}, callback) ⇒ AWS.Request
Retrieves details about an enabled control.
-
getLandingZone(params = {}, callback) ⇒ AWS.Request
Returns details about the landing zone.
-
getLandingZoneOperation(params = {}, callback) ⇒ AWS.Request
Returns the status of the specified landing zone operation.
-
listBaselines(params = {}, callback) ⇒ AWS.Request
Returns a summary list of all available baselines.
.
-
listEnabledBaselines(params = {}, callback) ⇒ AWS.Request
Returns a list of summaries describing
EnabledBaseline
resources. -
listEnabledControls(params = {}, callback) ⇒ AWS.Request
Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.
-
listLandingZones(params = {}, callback) ⇒ AWS.Request
Returns the landing zone ARN for the landing zone deployed in your managed account.
-
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Returns a list of tags associated with the resource.
-
resetEnabledBaseline(params = {}, callback) ⇒ AWS.Request
Re-enables an
EnabledBaseline
resource. -
resetLandingZone(params = {}, callback) ⇒ AWS.Request
This API call resets a landing zone.
-
tagResource(params = {}, callback) ⇒ AWS.Request
Applies tags to a resource.
-
untagResource(params = {}, callback) ⇒ AWS.Request
Removes tags from a resource.
-
updateEnabledBaseline(params = {}, callback) ⇒ AWS.Request
Updates an
EnabledBaseline
resource's applied parameters or version..
-
updateEnabledControl(params = {}, callback) ⇒ AWS.Request
Updates the configuration of an already enabled control.
If the enabled control shows an
EnablementStatus
of SUCCEEDED, supply parameters that are different from the currently configured parameters. -
updateLandingZone(params = {}, callback) ⇒ AWS.Request
This API call updates the landing zone.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.ControlTower(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Property Details
Method Details
createLandingZone(params = {}, callback) ⇒ AWS.Request
Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
deleteLandingZone(params = {}, callback) ⇒ AWS.Request
Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower.
disableBaseline(params = {}, callback) ⇒ AWS.Request
Disable an EnabledBaseline
resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline.
disableControl(params = {}, callback) ⇒ AWS.Request
This API call turns off a control. It starts an asynchronous operation that deletes AWS resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .
enableBaseline(params = {}, callback) ⇒ AWS.Request
Enable (apply) a Baseline
to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline
to the specified Target.
enableControl(params = {}, callback) ⇒ AWS.Request
This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .
getBaseline(params = {}, callback) ⇒ AWS.Request
Retrieve details about an existing Baseline
resource by specifying its identifier.
getBaselineOperation(params = {}, callback) ⇒ AWS.Request
Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline
, DisableBaseline
, UpdateEnabledBaseline
, ResetEnabledBaseline
. A status message is displayed in case of operation failure.
getControlOperation(params = {}, callback) ⇒ AWS.Request
Returns the status of a particular EnableControl
or DisableControl
operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Amazon Web Services Control Tower User Guide .
getEnabledBaseline(params = {}, callback) ⇒ AWS.Request
Retrieve details of an EnabledBaseline
resource by specifying its identifier.
getEnabledControl(params = {}, callback) ⇒ AWS.Request
Retrieves details about an enabled control. For usage examples, see the Amazon Web Services Control Tower User Guide .
getLandingZone(params = {}, callback) ⇒ AWS.Request
Returns details about the landing zone. Displays a message in case of error.
getLandingZoneOperation(params = {}, callback) ⇒ AWS.Request
Returns the status of the specified landing zone operation. Details for an operation are available for 60 days.
listBaselines(params = {}, callback) ⇒ AWS.Request
Returns a summary list of all available baselines.
listEnabledBaselines(params = {}, callback) ⇒ AWS.Request
Returns a list of summaries describing EnabledBaseline
resources. You can filter the list by the corresponding Baseline
or Target
of the EnabledBaseline
resources.
listEnabledControls(params = {}, callback) ⇒ AWS.Request
Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the Amazon Web Services Control Tower User Guide .
listLandingZones(params = {}, callback) ⇒ AWS.Request
Returns the landing zone ARN for the landing zone deployed in your managed account. This API also creates an ARN for existing accounts that do not yet have a landing zone ARN.
Returns one landing zone ARN.
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Returns a list of tags associated with the resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
resetEnabledBaseline(params = {}, callback) ⇒ AWS.Request
Re-enables an EnabledBaseline
resource. For example, this API can re-apply the existing Baseline
after a new member account is moved to the target OU.
resetLandingZone(params = {}, callback) ⇒ AWS.Request
This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in its original configuration.
tagResource(params = {}, callback) ⇒ AWS.Request
Applies tags to a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
untagResource(params = {}, callback) ⇒ AWS.Request
Removes tags from a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
updateEnabledBaseline(params = {}, callback) ⇒ AWS.Request
Updates an EnabledBaseline
resource's applied parameters or version.
updateEnabledControl(params = {}, callback) ⇒ AWS.Request
Updates the configuration of an already enabled control.
If the enabled control shows an EnablementStatus
of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.
If the enabled control shows an EnablementStatus
of FAILED, Amazon Web Services Control Tower will update the control to match any valid parameters that you supply.
If the DriftSummary
status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling DisableControl
and again calling EnableControl
, or you can run an extending governance operation. For usage examples, see the Amazon Web Services Control Tower User Guide