Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Config.PutConformancePack

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization. For information on how many conformance packs you can have per account, see Service Limits in the Config Developer Guide.

This API creates a service-linked role AWSServiceRoleForConfigConforms in your account. The service-linked role is created only when the role does not exist in your account.

You must specify only one of the follow parameters: TemplateS3Uri, TemplateBody or TemplateSSMDocumentDetails.

Synopsis

Creating a Request

data PutConformancePack Source #

See: newPutConformancePack smart constructor.

Constructors

PutConformancePack'

Fields

conformancePackInputParameters :: Maybe [ConformancePackInputParameter]
A list of ConformancePackInputParameter objects.
deliveryS3Bucket :: Maybe Text
The name of the Amazon S3 bucket where Config stores conformance pack templates.
This field is optional.
deliveryS3KeyPrefix :: Maybe Text
The prefix for the Amazon S3 bucket.
This field is optional.
templateBody :: Maybe Text
A string containing the full conformance pack template body. The structure containing the template body has a minimum length of 1 byte and a maximum length of 51,200 bytes.
You can use a YAML template with two resource types: Config rule (AWS::Config::ConfigRule) and remediation action (AWS::Config::RemediationConfiguration).
templateS3Uri :: Maybe Text
The location of the file containing the template body (s3://bucketname/prefix). The uri must point to a conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same Region as the conformance pack.
You must have access to read Amazon S3 bucket.
templateSSMDocumentDetails :: Maybe TemplateSSMDocumentDetails
An object of type TemplateSSMDocumentDetails, which contains the name or the Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.
conformancePackName :: Text
The unique name of the conformance pack you want to deploy.

Instances

Instances details

ToJSON PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods toJSON :: PutConformancePack -> Value # toEncoding :: PutConformancePack -> Encoding # toJSONList :: [PutConformancePack] -> Value # toEncodingList :: [PutConformancePack] -> Encoding #
ToHeaders PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods toHeaders :: PutConformancePack -> [Header] #
ToPath PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods toPath :: PutConformancePack -> ByteString #
ToQuery PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods toQuery :: PutConformancePack -> QueryString #
AWSRequest PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack Associated Types type AWSResponse PutConformancePack # Methods request :: (Service -> Service) -> PutConformancePack -> Request PutConformancePack # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutConformancePack -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutConformancePack))) #
Generic PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack Associated Types type Rep PutConformancePack :: Type -> Type # Methods from :: PutConformancePack -> Rep PutConformancePack x # to :: Rep PutConformancePack x -> PutConformancePack #
Read PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods readsPrec :: Int -> ReadS PutConformancePack # readList :: ReadS [PutConformancePack] # readPrec :: ReadPrec PutConformancePack # readListPrec :: ReadPrec [PutConformancePack] #
Show PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods showsPrec :: Int -> PutConformancePack -> ShowS # show :: PutConformancePack -> String # showList :: [PutConformancePack] -> ShowS #
NFData PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods rnf :: PutConformancePack -> () #
Eq PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods (==) :: PutConformancePack -> PutConformancePack -> Bool # (/=) :: PutConformancePack -> PutConformancePack -> Bool #
Hashable PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods hashWithSalt :: Int -> PutConformancePack -> Int # hash :: PutConformancePack -> Int #
type AWSResponse PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack type AWSResponse PutConformancePack = PutConformancePackResponse
type Rep PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack type Rep PutConformancePack = D1 ('MetaData "PutConformancePack" "Amazonka.Config.PutConformancePack" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "PutConformancePack'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "conformancePackInputParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConformancePackInputParameter])) :: (S1 ('MetaSel ('Just "deliveryS3Bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "deliveryS3KeyPrefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "templateBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "templateS3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "templateSSMDocumentDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TemplateSSMDocumentDetails)) :: S1 ('MetaSel ('Just "conformancePackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newPutConformancePack Source #

Arguments

:: Text	`PutConformancePack`
-> PutConformancePack

Create a value of PutConformancePack 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:

PutConformancePack, putConformancePack_conformancePackInputParameters - A list of ConformancePackInputParameter objects.

PutConformancePack, putConformancePack_deliveryS3Bucket - The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional.

PutConformancePack, putConformancePack_deliveryS3KeyPrefix - The prefix for the Amazon S3 bucket.

This field is optional.

$sel:templateBody:PutConformancePack', putConformancePack_templateBody - A string containing the full conformance pack template body. The structure containing the template body has a minimum length of 1 byte and a maximum length of 51,200 bytes.

You can use a YAML template with two resource types: Config rule (AWS::Config::ConfigRule) and remediation action (AWS::Config::RemediationConfiguration).

$sel:templateS3Uri:PutConformancePack', putConformancePack_templateS3Uri - The location of the file containing the template body (s3://bucketname/prefix). The uri must point to a conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same Region as the conformance pack.

You must have access to read Amazon S3 bucket.

PutConformancePack, putConformancePack_templateSSMDocumentDetails - An object of type TemplateSSMDocumentDetails, which contains the name or the Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.

PutConformancePack, putConformancePack_conformancePackName - The unique name of the conformance pack you want to deploy.

Request Lenses

putConformancePack_conformancePackInputParameters :: Lens' PutConformancePack (Maybe [ConformancePackInputParameter]) Source #

A list of ConformancePackInputParameter objects.

putConformancePack_deliveryS3Bucket :: Lens' PutConformancePack (Maybe Text) Source #

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional.

putConformancePack_deliveryS3KeyPrefix :: Lens' PutConformancePack (Maybe Text) Source #

The prefix for the Amazon S3 bucket.

This field is optional.

putConformancePack_templateBody :: Lens' PutConformancePack (Maybe Text) Source #

A string containing the full conformance pack template body. The structure containing the template body has a minimum length of 1 byte and a maximum length of 51,200 bytes.

You can use a YAML template with two resource types: Config rule (AWS::Config::ConfigRule) and remediation action (AWS::Config::RemediationConfiguration).

putConformancePack_templateS3Uri :: Lens' PutConformancePack (Maybe Text) Source #

The location of the file containing the template body (s3://bucketname/prefix). The uri must point to a conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same Region as the conformance pack.

You must have access to read Amazon S3 bucket.

putConformancePack_templateSSMDocumentDetails :: Lens' PutConformancePack (Maybe TemplateSSMDocumentDetails) Source #

An object of type TemplateSSMDocumentDetails, which contains the name or the Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.

putConformancePack_conformancePackName :: Lens' PutConformancePack Text Source #

The unique name of the conformance pack you want to deploy.

Destructuring the Response

data PutConformancePackResponse Source #

See: newPutConformancePackResponse smart constructor.

Constructors

PutConformancePackResponse'
Fields conformancePackArn :: Maybe Text ARN of the conformance pack. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic PutConformancePackResponse Source #
Instance details Defined in Amazonka.Config.PutConformancePack Associated Types type Rep PutConformancePackResponse :: Type -> Type # Methods from :: PutConformancePackResponse -> Rep PutConformancePackResponse x # to :: Rep PutConformancePackResponse x -> PutConformancePackResponse #
Read PutConformancePackResponse Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods readsPrec :: Int -> ReadS PutConformancePackResponse # readList :: ReadS [PutConformancePackResponse] # readPrec :: ReadPrec PutConformancePackResponse # readListPrec :: ReadPrec [PutConformancePackResponse] #
Show PutConformancePackResponse Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods showsPrec :: Int -> PutConformancePackResponse -> ShowS # show :: PutConformancePackResponse -> String # showList :: [PutConformancePackResponse] -> ShowS #
NFData PutConformancePackResponse Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods rnf :: PutConformancePackResponse -> () #
Eq PutConformancePackResponse Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods (==) :: PutConformancePackResponse -> PutConformancePackResponse -> Bool # (/=) :: PutConformancePackResponse -> PutConformancePackResponse -> Bool #
type Rep PutConformancePackResponse Source #
Instance details Defined in Amazonka.Config.PutConformancePack type Rep PutConformancePackResponse = D1 ('MetaData "PutConformancePackResponse" "Amazonka.Config.PutConformancePack" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "PutConformancePackResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "conformancePackArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutConformancePackResponse Source #

Arguments

:: Int	`$sel:httpStatus:PutConformancePackResponse'`
-> PutConformancePackResponse

Create a value of PutConformancePackResponse 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:

PutConformancePackResponse, putConformancePackResponse_conformancePackArn - ARN of the conformance pack.

$sel:httpStatus:PutConformancePackResponse', putConformancePackResponse_httpStatus - The response's http status code.

Response Lenses

putConformancePackResponse_conformancePackArn :: Lens' PutConformancePackResponse (Maybe Text) Source #

ARN of the conformance pack.

putConformancePackResponse_httpStatus :: Lens' PutConformancePackResponse Int Source #

The response's http status code.