| 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.PutResourceConfig
Description
Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in Config as Configuration Items. Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing Config APIs.
The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation.
When you call this API, Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource.
Write-only schema properites are not recorded as part of the published configuration item.
Synopsis
- data PutResourceConfig = PutResourceConfig' {
- resourceName :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- resourceType :: Text
- schemaVersionId :: Text
- resourceId :: Text
- configuration :: Text
- newPutResourceConfig :: Text -> Text -> Text -> Text -> PutResourceConfig
- putResourceConfig_resourceName :: Lens' PutResourceConfig (Maybe Text)
- putResourceConfig_tags :: Lens' PutResourceConfig (Maybe (HashMap Text Text))
- putResourceConfig_resourceType :: Lens' PutResourceConfig Text
- putResourceConfig_schemaVersionId :: Lens' PutResourceConfig Text
- putResourceConfig_resourceId :: Lens' PutResourceConfig Text
- putResourceConfig_configuration :: Lens' PutResourceConfig Text
- data PutResourceConfigResponse = PutResourceConfigResponse' {
- newPutResourceConfigResponse :: PutResourceConfigResponse
Creating a Request
data PutResourceConfig Source #
See: newPutResourceConfig smart constructor.
Constructors
| PutResourceConfig' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> PutResourceConfig |
Create a value of PutResourceConfig 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:resourceName:PutResourceConfig', putResourceConfig_resourceName - Name of the resource.
$sel:tags:PutResourceConfig', putResourceConfig_tags - Tags associated with the resource.
$sel:resourceType:PutResourceConfig', putResourceConfig_resourceType - The type of the resource. The custom resource type must be registered
with CloudFormation.
You cannot use the organization names “amzn”, “amazon”, “alexa”, “custom” with custom resource types. It is the first part of the ResourceType up to the first ::.
$sel:schemaVersionId:PutResourceConfig', putResourceConfig_schemaVersionId - Version of the schema registered for the ResourceType in CloudFormation.
$sel:resourceId:PutResourceConfig', putResourceConfig_resourceId - Unique identifier of the resource.
$sel:configuration:PutResourceConfig', putResourceConfig_configuration - The configuration object of the resource in valid JSON format. It must
match the schema registered with CloudFormation.
The configuration JSON must not exceed 64 KB.
Request Lenses
putResourceConfig_resourceName :: Lens' PutResourceConfig (Maybe Text) Source #
Name of the resource.
putResourceConfig_tags :: Lens' PutResourceConfig (Maybe (HashMap Text Text)) Source #
Tags associated with the resource.
putResourceConfig_resourceType :: Lens' PutResourceConfig Text Source #
The type of the resource. The custom resource type must be registered with CloudFormation.
You cannot use the organization names “amzn”, “amazon”, “alexa”, “custom” with custom resource types. It is the first part of the ResourceType up to the first ::.
putResourceConfig_schemaVersionId :: Lens' PutResourceConfig Text Source #
Version of the schema registered for the ResourceType in CloudFormation.
putResourceConfig_resourceId :: Lens' PutResourceConfig Text Source #
Unique identifier of the resource.
putResourceConfig_configuration :: Lens' PutResourceConfig Text Source #
The configuration object of the resource in valid JSON format. It must match the schema registered with CloudFormation.
The configuration JSON must not exceed 64 KB.
Destructuring the Response
data PutResourceConfigResponse Source #
See: newPutResourceConfigResponse smart constructor.
Constructors
| PutResourceConfigResponse' | |
Instances
newPutResourceConfigResponse :: PutResourceConfigResponse Source #
Create a value of PutResourceConfigResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.