/AWS1/CL_CFS=>PUTORGCONFORMANCEPACK()
¶
About PutOrganizationConformancePack¶
Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, see Service Limits in the Config Developer Guide.
Only a management account and a delegated administrator can call this API.
When calling this API with a delegated administrator, you must ensure Organizations
ListDelegatedAdministrator
permissions are added. An organization can have up to 3 delegated administrators.
This API enables organization service access for config-multiaccountsetup.amazonaws.com
through the EnableAWSServiceAccess
action and creates a
service-linked role AWSServiceRoleForConfigMultiAccountSetup
in the management or delegated administrator account of your organization.
The service-linked role is created only when the role does not exist in the caller account.
To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization
register-delegate-admin
for config-multiaccountsetup.amazonaws.com
.
Prerequisite: Ensure you call EnableAllFeatures
API to enable all features in an organization.
You must specify either the TemplateS3Uri
or the TemplateBody
parameter, but not both.
If you provide both Config uses the TemplateS3Uri
parameter and ignores the TemplateBody
parameter.
Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_ORGCONFORMANCEPACKNAME
TYPE /AWS1/CFSORGCONFORMANCEPACKN00
/AWS1/CFSORGCONFORMANCEPACKN00
¶
Name of the organization conformance pack you want to create.
Optional arguments:¶
IV_TEMPLATES3URI
TYPE /AWS1/CFSTEMPLATES3URI
/AWS1/CFSTEMPLATES3URI
¶
Location of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB).
You must have access to read Amazon S3 bucket. In addition, in order to ensure a successful deployment, the template object must not be in an archived storage class if this parameter is passed.
IV_TEMPLATEBODY
TYPE /AWS1/CFSTEMPLATEBODY
/AWS1/CFSTEMPLATEBODY
¶
A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
IV_DELIVERYS3BUCKET
TYPE /AWS1/CFSDELIVERYS3BUCKET
/AWS1/CFSDELIVERYS3BUCKET
¶
The name of the Amazon S3 bucket where Config stores conformance pack templates.
This field is optional. If used, it must be prefixed with
awsconfigconforms
.
IV_DELIVERYS3KEYPREFIX
TYPE /AWS1/CFSDELIVERYS3KEYPREFIX
/AWS1/CFSDELIVERYS3KEYPREFIX
¶
The prefix for the Amazon S3 bucket.
This field is optional.
IT_CONFORMANCEPACKINPPARAMS
TYPE /AWS1/CL_CFSCONFORMANCEPACKI00=>TT_CONFORMANCEPACKINPUTPARAMS
TT_CONFORMANCEPACKINPUTPARAMS
¶
A list of
ConformancePackInputParameter
objects.
IT_EXCLUDEDACCOUNTS
TYPE /AWS1/CL_CFSEXCLUDEDACCOUNTS_W=>TT_EXCLUDEDACCOUNTS
TT_EXCLUDEDACCOUNTS
¶
A list of Amazon Web Services accounts to be excluded from an organization conformance pack while deploying a conformance pack.