capacity_manager_organizations_access

Creates, updates, deletes, gets or lists a capacity_manager_organizations_access resource.

Overview

Name	capacity_manager_organizations_access
Type	Resource
Id	aws.ec2.capacity_manager_organizations_access

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
update_capacity_manager_organizations_access	update	OrganizationsAccess, region	DryRun, ClientToken	Updates the Organizations access setting for EC2 Capacity Manager. This controls whether Capacity Manager can aggregate data from all accounts in your Amazon Web Services Organization or only from the current account.

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
OrganizationsAccess	boolean	Specifies whether to enable or disable cross-account access for Amazon Web Services Organizations. When enabled, Capacity Manager aggregates data from all accounts in your organization.
region	string	AWS region (default: us-east-1)
ClientToken	string	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
DryRun	boolean	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

UPDATE examples

update_capacity_manager_organizations_access

Updates the Organizations access setting for EC2 Capacity Manager. This controls whether Capacity Manager can aggregate data from all accounts in your Amazon Web Services Organization or only from the current account.

UPDATE aws.ec2.capacity_manager_organizations_access
SET 
-- No updatable properties
WHERE 
OrganizationsAccess = '{{ OrganizationsAccess }}' --required
AND region = '{{ region }}' --required
AND DryRun = {{ DryRun}}
AND ClientToken = '{{ ClientToken}}'
RETURNING
capacity_manager_status,
organizations_access;