CfnResourceVersion¶
-
class
aws_cdk.aws_cloudformation.
CfnResourceVersion
(scope, id, *, schema_handler_package, type_name, execution_role_arn=None, logging_config=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::CloudFormation::ResourceVersion
.Registers a resource version with the CloudFormation service. Registering a resource version makes it available for use in CloudFormation templates in your AWS account , and includes:
Validating the resource schema.
Determining which handlers, if any, have been specified for the resource.
Making the resource available for use in your account.
For more information on how to develop resources and ready them for registration, see Creating Resource Providers in the CloudFormation CLI User Guide .
You can have a maximum of 50 resource versions registered at a time. This maximum is per account and per Region.
- CloudformationResource
AWS::CloudFormation::ResourceVersion
- Link
- 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 = cloudformation.CfnResourceVersion(self, "MyCfnResourceVersion", 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" ) )
Create a new
AWS::CloudFormation::ResourceVersion
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
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
,Dict
[str
,Any
],None
]) – Logging configuration information for a resource.
Methods
-
add_deletion_override
(path)¶ Syntactic sugar for
addOverride(path, undefined)
.- Parameters
path (
str
) – The path of the value to delete.- Return type
None
-
add_depends_on
(target)¶ Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters
target (
CfnResource
) –- Return type
None
-
add_metadata
(key, value)¶ Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
None
-
add_override
(path, value)¶ Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type
None
-
add_property_deletion_override
(property_path)¶ Adds an override that deletes the value of a property from the resource definition.
- Parameters
property_path (
str
) – The path to the property.- Return type
None
-
add_property_override
(property_path, value)¶ Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type
None
-
apply_removal_policy
(policy=None, *, apply_to_update_replace_policy=None, default=None)¶ Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type
None
-
get_att
(attribute_name)¶ Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters
attribute_name (
str
) – The name of the attribute.- Return type
-
get_metadata
(key)¶ Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- See
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- Return type
Any
-
inspect
(inspector)¶ Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type
None
-
override_logical_id
(new_logical_id)¶ Overrides the auto-generated logical ID with a specific ID.
- Parameters
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
- Returns
a string representation of this resource
Attributes
-
CFN_RESOURCE_TYPE_NAME
= 'AWS::CloudFormation::ResourceVersion'¶
-
attr_arn
¶ The Amazon Resource Name (ARN) of the resource version.
- CloudformationAttribute
Arn
- Return type
str
-
attr_is_default_version
¶ Whether the resource version is set as the default version.
- CloudformationAttribute
IsDefaultVersion
- Return type
-
attr_provisioning_type
¶ The provisioning behavior of the resource type.
CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
Valid values include:
FULLY_MUTABLE
: The resource type includes an update handler to process updates to the type during stack update operations.IMMUTABLE
: The resource type doesn’t include an update handler, so the type can’t be updated and must instead be replaced during stack update operations.NON_PROVISIONABLE
: The resource type doesn’t include all the following handlers, and therefore can’t actually be provisioned.create
read
delete
- CloudformationAttribute
ProvisioningType
- Return type
str
-
attr_type_arn
¶ The Amazon Resource Name (ARN) of the resource.
- CloudformationAttribute
TypeArn
- Return type
str
-
attr_version_id
¶ The ID of a specific version of the resource.
The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the resource version when it is registered.
- CloudformationAttribute
VersionId
- Return type
str
-
attr_visibility
¶ The scope at which the resource is visible and usable in CloudFormation operations.
Valid values include:
PRIVATE
: The resource is only visible and usable within the account in which it’s registered. CloudFormation marks any resources you register asPRIVATE
.PUBLIC
: The resource is publicly visible and usable within any Amazon account.
- CloudformationAttribute
Visibility
- Return type
str
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
cfn_resource_type
¶ AWS resource type.
- Return type
str
-
creation_stack
¶ return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- Return type
List
[str
]
-
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.
-
logging_config
¶ Logging configuration information for a resource.
-
logical_id
¶ The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Return type
str
- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
-
node
¶ The construct tree node associated with this construct.
- Return type
-
ref
¶ Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.- Return type
str
-
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* .
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
-
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``
Static Methods
-
classmethod
is_cfn_element
(x)¶ Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters
x (
Any
) –- Return type
bool
- Returns
The construct as a stack element or undefined if it is not a stack element.
-
classmethod
is_cfn_resource
(construct)¶ Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
LoggingConfigProperty¶
-
class
CfnResourceVersion.
LoggingConfigProperty
(*, log_group_name=None, log_role_arn=None)¶ Bases:
object
Logging configuration information for a resource.
- Parameters
log_group_name (
Optional
[str
]) – The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type’s handlers.log_role_arn (
Optional
[str
]) – The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
- Link
- 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 logging_config_property = cloudformation.CfnResourceVersion.LoggingConfigProperty( log_group_name="logGroupName", log_role_arn="logRoleArn" )
Attributes
-
log_group_name
¶ The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type’s handlers.
-
log_role_arn
¶ The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.