libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudFormation.RegisterType

Description

Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:

  • Validating the extension schema
  • Determining which handlers, if any, have been specified for the extension
  • Making the extension available for use in your account

For more information on how to develop extensions and ready them for registeration, see Creating Resource Providers in the CloudFormation CLI User Guide.

You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per region. Use DeregisterType to deregister specific extension versions if necessary.

Once you have initiated a registration request using RegisterType , you can use DescribeTypeRegistration to monitor the progress of the registration request.

Once you have registered a private extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

Synopsis

Creating a Request

data RegisterType Source #

See: newRegisterType smart constructor.

Constructors

RegisterType' 

Fields

  • executionRoleArn :: Maybe Text

    The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

    For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information on adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

    If your extension calls Amazon Web Services APIs in any of its handlers, you must create an <https:docs.aws.amazon.comIAMlatestUserGuideid_roles.html IAM execution role> that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

  • type' :: Maybe RegistryType

    The kind of extension.

  • clientRequestToken :: Maybe Text

    A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registeration request, even if the request is submitted multiple times.

  • loggingConfig :: Maybe LoggingConfig

    Specifies logging configuration information for an extension.

  • typeName :: Text

    The name of the extension being registered.

    We recommend that extension names adhere to the following patterns:

    • For resource types, company_or_organization::service::type.
    • For modules, company_or_organization::service::type::MODULE.

    The following organization namespaces are reserved and cannot be used in your extension names:

    • Alexa
    • AMZN
    • Amazon
    • AWS
    • Custom
    • Dev
  • schemaHandlerPackage :: Text

    A url to the S3 bucket containing the extension project package that contains the neccessary files for the extension you want to register.

    For information on generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.

    The user registering the extension must be able to access the package in the S3 bucket. That is, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

Instances

Instances details
Eq RegisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.RegisterType

Read RegisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.RegisterType

Show RegisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.RegisterType

Generic RegisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.RegisterType

Associated Types

type Rep RegisterType :: Type -> Type #

NFData RegisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.RegisterType

Methods

rnf :: RegisterType -> () #

Hashable RegisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.RegisterType

AWSRequest RegisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.RegisterType

Associated Types

type AWSResponse RegisterType #

ToHeaders RegisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.RegisterType

ToPath RegisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.RegisterType

ToQuery RegisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.RegisterType

type Rep RegisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.RegisterType

type Rep RegisterType = D1 ('MetaData "RegisterType" "Amazonka.CloudFormation.RegisterType" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "RegisterType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "executionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegistryType)) :*: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "loggingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfig)) :*: (S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "schemaHandlerPackage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse RegisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.RegisterType

newRegisterType Source #

Create a value of RegisterType 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:executionRoleArn:RegisterType', registerType_executionRoleArn - The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information on adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an <https:docs.aws.amazon.comIAMlatestUserGuideid_roles.html IAM execution role> that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

$sel:type':RegisterType', registerType_type - The kind of extension.

$sel:clientRequestToken:RegisterType', registerType_clientRequestToken - A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registeration request, even if the request is submitted multiple times.

$sel:loggingConfig:RegisterType', registerType_loggingConfig - Specifies logging configuration information for an extension.

$sel:typeName:RegisterType', registerType_typeName - The name of the extension being registered.

We recommend that extension names adhere to the following patterns:

  • For resource types, company_or_organization::service::type.
  • For modules, company_or_organization::service::type::MODULE.

The following organization namespaces are reserved and cannot be used in your extension names:

  • Alexa
  • AMZN
  • Amazon
  • AWS
  • Custom
  • Dev

$sel:schemaHandlerPackage:RegisterType', registerType_schemaHandlerPackage - A url to the S3 bucket containing the extension project package that contains the neccessary files for the extension you want to register.

For information on generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.

The user registering the extension must be able to access the package in the S3 bucket. That is, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

Request Lenses

registerType_executionRoleArn :: Lens' RegisterType (Maybe Text) Source #

The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension.

For CloudFormation to assume the specified execution role, the role must contain a trust relationship with the CloudFormation service principle (resources.cloudformation.amazonaws.com). For more information on adding trust relationships, see Modifying a role trust policy in the Identity and Access Management User Guide.

If your extension calls Amazon Web Services APIs in any of its handlers, you must create an <https:docs.aws.amazon.comIAMlatestUserGuideid_roles.html IAM execution role> that includes the necessary permissions to call those Amazon Web Services APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource type handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource type handler, thereby supplying your resource type with the appropriate credentials.

registerType_clientRequestToken :: Lens' RegisterType (Maybe Text) Source #

A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registeration request, even if the request is submitted multiple times.

registerType_loggingConfig :: Lens' RegisterType (Maybe LoggingConfig) Source #

Specifies logging configuration information for an extension.

registerType_typeName :: Lens' RegisterType Text Source #

The name of the extension being registered.

We recommend that extension names adhere to the following patterns:

  • For resource types, company_or_organization::service::type.
  • For modules, company_or_organization::service::type::MODULE.

The following organization namespaces are reserved and cannot be used in your extension names:

  • Alexa
  • AMZN
  • Amazon
  • AWS
  • Custom
  • Dev

registerType_schemaHandlerPackage :: Lens' RegisterType Text Source #

A url to the S3 bucket containing the extension project package that contains the neccessary files for the extension you want to register.

For information on generating a schema handler package for the extension you want to register, see submit in the CloudFormation CLI User Guide.

The user registering the extension must be able to access the package in the S3 bucket. That is, the user needs to have GetObject permissions for the schema handler package. For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Identity and Access Management User Guide.

Destructuring the Response

data RegisterTypeResponse Source #

See: newRegisterTypeResponse smart constructor.

Constructors

RegisterTypeResponse' 

Fields

  • registrationToken :: Maybe Text

    The identifier for this registration request.

    Use this registration token when calling DescribeTypeRegistration , which returns information about the status and IDs of the extension registration.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq RegisterTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.RegisterType

Read RegisterTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.RegisterType

Show RegisterTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.RegisterType

Generic RegisterTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.RegisterType

Associated Types

type Rep RegisterTypeResponse :: Type -> Type #

NFData RegisterTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.RegisterType

Methods

rnf :: RegisterTypeResponse -> () #

type Rep RegisterTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.RegisterType

type Rep RegisterTypeResponse = D1 ('MetaData "RegisterTypeResponse" "Amazonka.CloudFormation.RegisterType" "libZSservicesZSamazonka-cloudformationZSamazonka-cloudformation" 'False) (C1 ('MetaCons "RegisterTypeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "registrationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRegisterTypeResponse Source #

Create a value of RegisterTypeResponse 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:registrationToken:RegisterTypeResponse', registerTypeResponse_registrationToken - The identifier for this registration request.

Use this registration token when calling DescribeTypeRegistration , which returns information about the status and IDs of the extension registration.

$sel:httpStatus:RegisterTypeResponse', registerTypeResponse_httpStatus - The response's http status code.

Response Lenses

registerTypeResponse_registrationToken :: Lens' RegisterTypeResponse (Maybe Text) Source #

The identifier for this registration request.

Use this registration token when calling DescribeTypeRegistration , which returns information about the status and IDs of the extension registration.