libZSservicesZSamazonka-configZSamazonka-config
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Config.PutOrganizationConformancePack

Description

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

Only a master 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.

This API enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup in the master 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.

You can create 50 conformance packs with 25 Config rules in each pack and 3 delegated administrator per organization.

Synopsis

Creating a Request

data PutOrganizationConformancePack Source #

See: newPutOrganizationConformancePack smart constructor.

Constructors

PutOrganizationConformancePack' 

Fields

Instances

Instances details
Eq PutOrganizationConformancePack Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

Read PutOrganizationConformancePack Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

Show PutOrganizationConformancePack Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

Generic PutOrganizationConformancePack Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

Associated Types

type Rep PutOrganizationConformancePack :: Type -> Type #

NFData PutOrganizationConformancePack Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

Hashable PutOrganizationConformancePack Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

ToJSON PutOrganizationConformancePack Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

AWSRequest PutOrganizationConformancePack Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

ToHeaders PutOrganizationConformancePack Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

ToPath PutOrganizationConformancePack Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

ToQuery PutOrganizationConformancePack Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

type Rep PutOrganizationConformancePack Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

type Rep PutOrganizationConformancePack = D1 ('MetaData "PutOrganizationConformancePack" "Amazonka.Config.PutOrganizationConformancePack" "libZSservicesZSamazonka-configZSamazonka-config" 'False) (C1 ('MetaCons "PutOrganizationConformancePack'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deliveryS3Bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "deliveryS3KeyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "templateS3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "conformancePackInputParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConformancePackInputParameter])) :*: S1 ('MetaSel ('Just "excludedAccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "templateBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "organizationConformancePackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse PutOrganizationConformancePack Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

newPutOrganizationConformancePack Source #

Create a value of PutOrganizationConformancePack with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:deliveryS3Bucket:PutOrganizationConformancePack', putOrganizationConformancePack_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.

$sel:deliveryS3KeyPrefix:PutOrganizationConformancePack', putOrganizationConformancePack_deliveryS3KeyPrefix - The prefix for the Amazon S3 bucket.

This field is optional.

$sel:templateS3Uri:PutOrganizationConformancePack', putOrganizationConformancePack_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.

$sel:conformancePackInputParameters:PutOrganizationConformancePack', putOrganizationConformancePack_conformancePackInputParameters - A list of ConformancePackInputParameter objects.

$sel:excludedAccounts:PutOrganizationConformancePack', putOrganizationConformancePack_excludedAccounts - A list of Amazon Web Services accounts to be excluded from an organization conformance pack while deploying a conformance pack.

$sel:templateBody:PutOrganizationConformancePack', putOrganizationConformancePack_templateBody - 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.

$sel:organizationConformancePackName:PutOrganizationConformancePack', putOrganizationConformancePack_organizationConformancePackName - Name of the organization conformance pack you want to create.

Request Lenses

putOrganizationConformancePack_deliveryS3Bucket :: Lens' PutOrganizationConformancePack (Maybe Text) Source #

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.

putOrganizationConformancePack_deliveryS3KeyPrefix :: Lens' PutOrganizationConformancePack (Maybe Text) Source #

The prefix for the Amazon S3 bucket.

This field is optional.

putOrganizationConformancePack_templateS3Uri :: Lens' PutOrganizationConformancePack (Maybe Text) Source #

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.

putOrganizationConformancePack_excludedAccounts :: Lens' PutOrganizationConformancePack (Maybe [Text]) Source #

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

putOrganizationConformancePack_templateBody :: Lens' PutOrganizationConformancePack (Maybe Text) Source #

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.

Destructuring the Response

data PutOrganizationConformancePackResponse Source #

Constructors

PutOrganizationConformancePackResponse' 

Fields

Instances

Instances details
Eq PutOrganizationConformancePackResponse Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

Read PutOrganizationConformancePackResponse Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

Show PutOrganizationConformancePackResponse Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

Generic PutOrganizationConformancePackResponse Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

NFData PutOrganizationConformancePackResponse Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

type Rep PutOrganizationConformancePackResponse Source # 
Instance details

Defined in Amazonka.Config.PutOrganizationConformancePack

type Rep PutOrganizationConformancePackResponse = D1 ('MetaData "PutOrganizationConformancePackResponse" "Amazonka.Config.PutOrganizationConformancePack" "libZSservicesZSamazonka-configZSamazonka-config" 'False) (C1 ('MetaCons "PutOrganizationConformancePackResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organizationConformancePackArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutOrganizationConformancePackResponse Source #

Create a value of PutOrganizationConformancePackResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:organizationConformancePackArn:PutOrganizationConformancePackResponse', putOrganizationConformancePackResponse_organizationConformancePackArn - ARN of the organization conformance pack.

$sel:httpStatus:PutOrganizationConformancePackResponse', putOrganizationConformancePackResponse_httpStatus - The response's http status code.

Response Lenses