organizations_access

Creates, updates, deletes, gets or lists an organizations_access resource.

Overview

Name	organizations_access
Type	Resource
Id	aws.cloudformation.organizations_access

Fields

The following fields are returned by SELECT queries:

describe_organizations_access

Name	Datatype	Description
line_items	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_organizations_access	select	region	CallAs	Retrieves information about the account's OrganizationAccess status. This API can be called either by the management account or the delegated administrator by using the CallAs parameter. This API can also be called without the CallAs parameter by the management account.
activate_organizations_access	exec	region		Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.
deactivate_organizations_access	exec	region		Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your organization.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
CallAs	string	[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default, SELF is specified. If you are signed in to the management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator in the CloudFormation User Guide.

SELECT examples

describe_organizations_access

Retrieves information about the account's OrganizationAccess status. This API can be called either by the management account or the delegated administrator by using the CallAs parameter. This API can also be called without the CallAs parameter by the management account.

SELECT
line_items
FROM aws.cloudformation.organizations_access
WHERE region = '{{ region }}' -- required
AND CallAs = '{{ CallAs }}'
;

Lifecycle Methods

activate_organizations_access

Activate trusted access with Organizations. With trusted access between StackSets and Organizations activated, the management account has permissions to create and manage StackSets for your organization.

EXEC aws.cloudformation.organizations_access.activate_organizations_access 
@region='{{ region }}' --required
;

deactivate_organizations_access

Deactivates trusted access with Organizations. If trusted access is deactivated, the management account does not have permissions to create and manage service-managed StackSets for your organization.

EXEC aws.cloudformation.organizations_access.deactivate_organizations_access 
@region='{{ region }}' --required
;