Put Organization Conformance Pack

configservice_put_organization_conformance_pack

R Documentation

Deploys conformance packs across member accounts in an Amazon Web Services Organization¶

Description¶

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.

When you use put_organization_conformance_pack to deploy conformance packs across member accounts, the operation can create Config rules and remediation actions without requiring config:PutConfigRule or config:PutRemediationConfigurations permissions in member account IAM policies.

This API uses the AWSServiceRoleForConfigConforms service-linked role in each member account to create conformance pack resources. This service-linked role includes the permissions to create Config rules and remediation configurations, even if member account IAM policies explicitly deny these actions.

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.

Usage¶

configservice_put_organization_conformance_pack(
  OrganizationConformancePackName, TemplateS3Uri, TemplateBody,
  DeliveryS3Bucket, DeliveryS3KeyPrefix, ConformancePackInputParameters,
  ExcludedAccounts)

Arguments¶

OrganizationConformancePackName

[required] Name of the organization conformance pack you want to create.

TemplateS3Uri

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.

TemplateBody

A string that contains the 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.

DeliveryS3Bucket

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.

DeliveryS3KeyPrefix

The prefix for the Amazon S3 bucket.

This field is optional.

ConformancePackInputParameters

A list of ConformancePackInputParameter objects.

ExcludedAccounts

A list of Amazon Web Services accounts to be excluded from an organization conformance pack while deploying a conformance pack.

Value¶

A list with the following syntax:

list(
  OrganizationConformancePackArn = "string"
)

Request syntax¶

svc$put_organization_conformance_pack(
  OrganizationConformancePackName = "string",
  TemplateS3Uri = "string",
  TemplateBody = "string",
  DeliveryS3Bucket = "string",
  DeliveryS3KeyPrefix = "string",
  ConformancePackInputParameters = list(
    list(
      ParameterName = "string",
      ParameterValue = "string"
    )
  ),
  ExcludedAccounts = list(
    "string"
  )
)