Amazonka.Config.PutResourceConfig

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.

Creating a Request

data PutResourceConfig

See: newPutResourceConfig smart constructor.

Constructors

PutResourceConfig'

Fields

• resourceName :: Maybe Text

  Name of the resource.

• tags :: Maybe (HashMap Text Text)

  Tags associated with the resource.

  This field is not to be confused with the Amazon Web Services-wide tag feature for Amazon Web Services resources. Tags for PutResourceConfig are tags that you supply for the configuration items of your custom resources.

• resourceType :: Text

  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 ::.

• schemaVersionId :: Text

  Version of the schema registered for the ResourceType in CloudFormation.

• resourceId :: Text

  Unique identifier of the resource.

• configuration :: Text

  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.

Instances

ToJSON PutResourceConfig

Defined in Amazonka.Config.PutResourceConfig

Methods

toJSON :: PutResourceConfig -> Value

toEncoding :: PutResourceConfig -> Encoding

toJSONList :: [PutResourceConfig] -> Value

toEncodingList :: [PutResourceConfig] -> Encoding

ToHeaders PutResourceConfig

Defined in Amazonka.Config.PutResourceConfig

Methods

toHeaders :: PutResourceConfig -> [Header]

ToPath PutResourceConfig

Defined in Amazonka.Config.PutResourceConfig

Methods

toPath :: PutResourceConfig -> ByteString

ToQuery PutResourceConfig

Defined in Amazonka.Config.PutResourceConfig

Methods

toQuery :: PutResourceConfig -> QueryString

AWSRequest PutResourceConfig

Defined in Amazonka.Config.PutResourceConfig

Associated Types

type AWSResponse PutResourceConfig

Methods

request :: (Service -> Service) -> PutResourceConfig -> Request PutResourceConfig

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutResourceConfig -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutResourceConfig)))

Generic PutResourceConfig

Defined in Amazonka.Config.PutResourceConfig

Associated Types

type Rep PutResourceConfig :: Type -> Type

Methods

from :: PutResourceConfig -> Rep PutResourceConfig x

to :: Rep PutResourceConfig x -> PutResourceConfig

Read PutResourceConfig

Defined in Amazonka.Config.PutResourceConfig

Methods

readsPrec :: Int -> ReadS PutResourceConfig

readList :: ReadS [PutResourceConfig]

readPrec :: ReadPrec PutResourceConfig

readListPrec :: ReadPrec [PutResourceConfig]

Show PutResourceConfig

Defined in Amazonka.Config.PutResourceConfig

Methods

showsPrec :: Int -> PutResourceConfig -> ShowS

show :: PutResourceConfig -> String

showList :: [PutResourceConfig] -> ShowS

NFData PutResourceConfig

Defined in Amazonka.Config.PutResourceConfig

Methods

rnf :: PutResourceConfig -> ()

Eq PutResourceConfig

Defined in Amazonka.Config.PutResourceConfig

Methods

(==) :: PutResourceConfig -> PutResourceConfig -> Bool

(/=) :: PutResourceConfig -> PutResourceConfig -> Bool

Hashable PutResourceConfig

Defined in Amazonka.Config.PutResourceConfig

Methods

hashWithSalt :: Int -> PutResourceConfig -> Int

hash :: PutResourceConfig -> Int

type AWSResponse PutResourceConfig

Defined in Amazonka.Config.PutResourceConfig

type AWSResponse PutResourceConfig = PutResourceConfigResponse

type Rep PutResourceConfig

Defined in Amazonka.Config.PutResourceConfig

type Rep PutResourceConfig = D1 ('MetaData "PutResourceConfig" "Amazonka.Config.PutResourceConfig" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "PutResourceConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "resourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "schemaVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newPutResourceConfig

Arguments

:: Text

PutResourceConfig

-> Text

$sel:schemaVersionId:PutResourceConfig'

-> Text

PutResourceConfig

-> Text

PutResourceConfig

-> 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:

PutResourceConfig, putResourceConfig_resourceName - Name of the resource.

PutResourceConfig, putResourceConfig_tags - Tags associated with the resource.

This field is not to be confused with the Amazon Web Services-wide tag feature for Amazon Web Services resources. Tags for PutResourceConfig are tags that you supply for the configuration items of your custom resources.

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.

PutResourceConfig, putResourceConfig_resourceId - Unique identifier of the resource.

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)

Name of the resource.

putResourceConfig_tags :: Lens' PutResourceConfig (Maybe (HashMap Text Text))

Tags associated with the resource.

This field is not to be confused with the Amazon Web Services-wide tag feature for Amazon Web Services resources. Tags for PutResourceConfig are tags that you supply for the configuration items of your custom resources.

putResourceConfig_resourceType :: Lens' PutResourceConfig Text

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

Version of the schema registered for the ResourceType in CloudFormation.

putResourceConfig_resourceId :: Lens' PutResourceConfig Text

Unique identifier of the resource.

putResourceConfig_configuration :: Lens' PutResourceConfig Text

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

See: newPutResourceConfigResponse smart constructor.

Constructors

PutResourceConfigResponse'

Instances

Generic PutResourceConfigResponse

Defined in Amazonka.Config.PutResourceConfig

Associated Types

type Rep PutResourceConfigResponse :: Type -> Type

Methods

from :: PutResourceConfigResponse -> Rep PutResourceConfigResponse x

to :: Rep PutResourceConfigResponse x -> PutResourceConfigResponse

Read PutResourceConfigResponse

Defined in Amazonka.Config.PutResourceConfig

Methods

readsPrec :: Int -> ReadS PutResourceConfigResponse

readList :: ReadS [PutResourceConfigResponse]

readPrec :: ReadPrec PutResourceConfigResponse

readListPrec :: ReadPrec [PutResourceConfigResponse]

Show PutResourceConfigResponse

Defined in Amazonka.Config.PutResourceConfig

Methods

showsPrec :: Int -> PutResourceConfigResponse -> ShowS

show :: PutResourceConfigResponse -> String

showList :: [PutResourceConfigResponse] -> ShowS

NFData PutResourceConfigResponse

Defined in Amazonka.Config.PutResourceConfig

Methods

rnf :: PutResourceConfigResponse -> ()

Eq PutResourceConfigResponse

Defined in Amazonka.Config.PutResourceConfig

Methods

(==) :: PutResourceConfigResponse -> PutResourceConfigResponse -> Bool

(/=) :: PutResourceConfigResponse -> PutResourceConfigResponse -> Bool

type Rep PutResourceConfigResponse

Defined in Amazonka.Config.PutResourceConfig

type Rep PutResourceConfigResponse = D1 ('MetaData "PutResourceConfigResponse" "Amazonka.Config.PutResourceConfig" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "PutResourceConfigResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutResourceConfigResponse :: PutResourceConfigResponse

Create a value of PutResourceConfigResponse with all optional fields omitted.

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