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 |
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
- data PutConformancePack = PutConformancePack' {}
- newPutConformancePack :: Text -> PutConformancePack
- putConformancePack_conformancePackInputParameters :: Lens' PutConformancePack (Maybe [ConformancePackInputParameter])
- putConformancePack_deliveryS3Bucket :: Lens' PutConformancePack (Maybe Text)
- putConformancePack_deliveryS3KeyPrefix :: Lens' PutConformancePack (Maybe Text)
- putConformancePack_templateBody :: Lens' PutConformancePack (Maybe Text)
- putConformancePack_templateS3Uri :: Lens' PutConformancePack (Maybe Text)
- putConformancePack_templateSSMDocumentDetails :: Lens' PutConformancePack (Maybe TemplateSSMDocumentDetails)
- putConformancePack_conformancePackName :: Lens' PutConformancePack Text
- data PutConformancePackResponse = PutConformancePackResponse' {}
- newPutConformancePackResponse :: Int -> PutConformancePackResponse
- putConformancePackResponse_conformancePackArn :: Lens' PutConformancePackResponse (Maybe Text)
- putConformancePackResponse_httpStatus :: Lens' PutConformancePackResponse Int
Creating a Request
data PutConformancePack Source #
See: newPutConformancePack
smart constructor.
PutConformancePack' | |
|
Instances
newPutConformancePack Source #
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.
PutConformancePackResponse' | |
|
Instances
newPutConformancePackResponse Source #
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.