CfnResourceVersionProps

class aws_cdk.aws_cloudformation.CfnResourceVersionProps(*, schema_handler_package, type_name, execution_role_arn=None, logging_config=None)

Bases: object

Properties for defining a CfnResourceVersion.

Parameters
  • schema_handler_package (str) – A URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register. For information on generating a schema handler package for the resource you want to register, see submit in the CloudFormation CLI User Guide . .. epigraph:: The user registering the resource 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 AWS Identity and Access Management User Guide .

  • type_name (str) – The name of the resource being registered. We recommend that resource names adhere to the following pattern: company_or_organization :: service :: type . .. epigraph:: The following organization namespaces are reserved and can’t be used in your resource names: - Alexa - AMZN - Amazon - AWS - Custom - Dev

  • execution_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource. If your resource calls AWS APIs in any of its handlers, you must create an `IAM execution role <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html>`_ that includes the necessary permissions to call those AWS 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.

  • logging_config (Union[IResolvable, LoggingConfigProperty, None]) – Logging configuration information for a resource.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_cloudformation as cloudformation

cfn_resource_version_props = cloudformation.CfnResourceVersionProps(
    schema_handler_package="schemaHandlerPackage",
    type_name="typeName",

    # the properties below are optional
    execution_role_arn="executionRoleArn",
    logging_config=cloudformation.CfnResourceVersion.LoggingConfigProperty(
        log_group_name="logGroupName",
        log_role_arn="logRoleArn"
    )
)

Attributes

execution_role_arn

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

If your resource calls AWS APIs in any of its handlers, you must create an `IAM execution role <https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html>`_ that includes the necessary permissions to call those AWS 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-executionrolearn

Return type

Optional[str]

logging_config

Logging configuration information for a resource.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-loggingconfig

Return type

Union[IResolvable, LoggingConfigProperty, None]

schema_handler_package

A URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register.

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

The user registering the resource must be able to access the package in the S3 bucket. That is, the user needs to have `GetObject <https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html>`_ permissions for the schema handler package. For more information, see `Actions, Resources, and Condition Keys for Amazon S3 <https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html>`_ in the *AWS Identity and Access Management User Guide* .
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-schemahandlerpackage

Return type

str

type_name

The name of the resource being registered.

We recommend that resource names adhere to the following pattern: company_or_organization :: service :: type . .. epigraph:

The following organization namespaces are reserved and can't be used in your resource names:

- ``Alexa``
- ``AMZN``
- ``Amazon``
- ``AWS``
- ``Custom``
- ``Dev``
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-resourceversion.html#cfn-cloudformation-resourceversion-typename

Return type

str