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 |
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 about how to develop extensions and ready them for registration, 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
- data RegisterType = RegisterType' {}
- newRegisterType :: Text -> Text -> RegisterType
- registerType_clientRequestToken :: Lens' RegisterType (Maybe Text)
- registerType_executionRoleArn :: Lens' RegisterType (Maybe Text)
- registerType_loggingConfig :: Lens' RegisterType (Maybe LoggingConfig)
- registerType_type :: Lens' RegisterType (Maybe RegistryType)
- registerType_typeName :: Lens' RegisterType Text
- registerType_schemaHandlerPackage :: Lens' RegisterType Text
- data RegisterTypeResponse = RegisterTypeResponse' {}
- newRegisterTypeResponse :: Int -> RegisterTypeResponse
- registerTypeResponse_registrationToken :: Lens' RegisterTypeResponse (Maybe Text)
- registerTypeResponse_httpStatus :: Lens' RegisterTypeResponse Int
Creating a Request
data RegisterType Source #
See: newRegisterType
smart constructor.
RegisterType' | |
|
Instances
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:
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 registration request, even if the request is submitted
multiple times.
$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 about
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:loggingConfig:RegisterType'
, registerType_loggingConfig
- Specifies logging configuration information for an extension.
RegisterType
, registerType_type
- The kind of extension.
RegisterType
, registerType_typeName
- The name of the extension being registered.
We suggest that extension names adhere to the following patterns:
- For resource types, company_or_organization::service::type.
- For modules, company_or_organization::service::type::MODULE.
- For hooks, MyCompany::Testing::MyTestHook.
The following organization namespaces are reserved and can't 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 necessary files for the extension you want to register.
For information about 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's, 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_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 registration request, even if the request is submitted multiple times.
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 about
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_loggingConfig :: Lens' RegisterType (Maybe LoggingConfig) Source #
Specifies logging configuration information for an extension.
registerType_type :: Lens' RegisterType (Maybe RegistryType) Source #
The kind of extension.
registerType_typeName :: Lens' RegisterType Text Source #
The name of the extension being registered.
We suggest that extension names adhere to the following patterns:
- For resource types, company_or_organization::service::type.
- For modules, company_or_organization::service::type::MODULE.
- For hooks, MyCompany::Testing::MyTestHook.
The following organization namespaces are reserved and can't 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 necessary files for the extension you want to register.
For information about 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's, 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.
RegisterTypeResponse' | |
|
Instances
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.
registerTypeResponse_httpStatus :: Lens' RegisterTypeResponse Int Source #
The response's http status code.