Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

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 Amazon Web Services Organization.

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 either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.

Synopsis

Creating a Request

data PutConformancePack Source #

See: newPutConformancePack smart constructor.

Constructors

PutConformancePack'

Fields

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.
templateS3Uri :: Maybe Text
Location of file containing the template body (s3://bucketname/prefix). The uri must point to the 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.
conformancePackInputParameters :: Maybe [ConformancePackInputParameter]
A list of ConformancePackInputParameter objects.
templateBody :: Maybe Text
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.
You can only use a YAML template with one resource type, that is, config rule and a remediation action.
conformancePackName :: Text
Name of the conformance pack you want to create.

Instances

Instances details

Eq PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods (==) :: PutConformancePack -> PutConformancePack -> Bool # (/=) :: PutConformancePack -> PutConformancePack -> Bool #
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 #
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 #
NFData PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods rnf :: PutConformancePack -> () #
Hashable PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods hashWithSalt :: Int -> PutConformancePack -> Int # hash :: PutConformancePack -> Int #
ToJSON PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods toJSON :: PutConformancePack -> Value # toEncoding :: PutConformancePack -> Encoding # toJSONList :: [PutConformancePack] -> Value # toEncodingList :: [PutConformancePack] -> Encoding #
AWSRequest PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack Associated Types type AWSResponse PutConformancePack # Methods request :: PutConformancePack -> Request PutConformancePack # response :: MonadResource m => Logger -> Service -> Proxy PutConformancePack -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutConformancePack))) #
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 #
type Rep PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack type Rep PutConformancePack = D1 ('MetaData "PutConformancePack" "Amazonka.Config.PutConformancePack" "libZSservicesZSamazonka-configZSamazonka-config" 'False) (C1 ('MetaCons "PutConformancePack'" '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 "templateBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "conformancePackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse PutConformancePack Source #
Instance details Defined in Amazonka.Config.PutConformancePack type AWSResponse PutConformancePack = PutConformancePackResponse

newPutConformancePack Source #

Arguments

:: Text	`$sel:conformancePackName: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:

$sel:deliveryS3Bucket:PutConformancePack', putConformancePack_deliveryS3Bucket - The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional.

$sel:deliveryS3KeyPrefix:PutConformancePack', putConformancePack_deliveryS3KeyPrefix - The prefix for the Amazon S3 bucket.

This field is optional.

$sel:templateS3Uri:PutConformancePack', putConformancePack_templateS3Uri - Location of file containing the template body (s3://bucketname/prefix). The uri must point to the 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.

$sel:conformancePackInputParameters:PutConformancePack', putConformancePack_conformancePackInputParameters - A list of ConformancePackInputParameter objects.

$sel:templateBody:PutConformancePack', putConformancePack_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.

You can only use a YAML template with one resource type, that is, config rule and a remediation action.

$sel:conformancePackName:PutConformancePack', putConformancePack_conformancePackName - Name of the conformance pack you want to create.

Request Lenses

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_templateS3Uri :: Lens' PutConformancePack (Maybe Text) Source #

Location of file containing the template body (s3://bucketname/prefix). The uri must point to the 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_conformancePackInputParameters :: Lens' PutConformancePack (Maybe [ConformancePackInputParameter]) Source #

A list of ConformancePackInputParameter objects.

putConformancePack_templateBody :: Lens' PutConformancePack (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.

You can only use a YAML template with one resource type, that is, config rule and a remediation action.

putConformancePack_conformancePackName :: Lens' PutConformancePack Text Source #

Name of the conformance pack you want to create.

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

Eq PutConformancePackResponse Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods (==) :: PutConformancePackResponse -> PutConformancePackResponse -> Bool # (/=) :: PutConformancePackResponse -> PutConformancePackResponse -> Bool #
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 #
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 #
NFData PutConformancePackResponse Source #
Instance details Defined in Amazonka.Config.PutConformancePack Methods rnf :: PutConformancePackResponse -> () #
type Rep PutConformancePackResponse Source #
Instance details Defined in Amazonka.Config.PutConformancePack type Rep PutConformancePackResponse = D1 ('MetaData "PutConformancePackResponse" "Amazonka.Config.PutConformancePack" "libZSservicesZSamazonka-configZSamazonka-config" '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:

$sel:conformancePackArn: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.