Package software.amazon.awscdk.cfnpropertymixins.services.cloudformation

Interface CfnResourceVersionMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnResourceVersionMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.969Z")
@Stability(Stable)
public interface CfnResourceVersionMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnResourceVersionPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cloudformation.*;
 CfnResourceVersionMixinProps cfnResourceVersionMixinProps = CfnResourceVersionMixinProps.builder()
         .executionRoleArn("executionRoleArn")
         .loggingConfig(LoggingConfigProperty.builder()
                 .logGroupName("logGroupName")
                 .logRoleArn("logRoleArn")
                 .build())
         .schemaHandlerPackage("schemaHandlerPackage")
         .typeName("typeName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnResourceVersionMixinProps.Builder	A builder for CfnResourceVersionMixinProps
static final class	CfnResourceVersionMixinProps.Jsii$Proxy	An implementation for CfnResourceVersionMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnResourceVersionMixinProps.Builder	builder()
default String	getExecutionRoleArn()	The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource.
default Object	getLoggingConfig()	Logging configuration information for a resource.
default String	getSchemaHandlerPackage()	A URL to the S3 bucket for the resource project package that contains the necessary files for the resource you want to register.
default String	getTypeName()	The name of the resource being registered.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExecutionRoleArn

@Stability(Stable)
@Nullable
default String getExecutionRoleArn()

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

See Also:

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

getLoggingConfig

@Stability(Stable)
@Nullable
default Object getLoggingConfig()

Logging configuration information for a resource.

Returns union: either IResolvable or CfnResourceVersionPropsMixin.LoggingConfigProperty

See Also:

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

getSchemaHandlerPackage

@Stability(Stable)
@Nullable
default String getSchemaHandlerPackage()

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

For information on generating a schema handler package, see Modeling resource types to use with CloudFormation in the CloudFormation Command Line Interface (CLI) User Guide .

To register the resource version, you must have s3:GetObject permissions to access the S3 objects.

See Also:

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

getTypeName

@Stability(Stable)
@Nullable
default String getTypeName()

The name of the resource being registered.

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

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

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

See Also:

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

builder

@Stability(Stable)
static CfnResourceVersionMixinProps.Builder builder()

Returns:

a CfnResourceVersionMixinProps.Builder of CfnResourceVersionMixinProps