Package software.amazon.awscdk.services.cloudformation

Interface CfnResourceVersionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnResourceVersionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-17T21:37:27.456Z")
@Stability(Stable)
public interface CfnResourceVersionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnResourceVersion.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudformation.*;
 CfnResourceVersionProps cfnResourceVersionProps = CfnResourceVersionProps.builder()
         .schemaHandlerPackage("schemaHandlerPackage")
         .typeName("typeName")
         // the properties below are optional
         .executionRoleArn("executionRoleArn")
         .loggingConfig(LoggingConfigProperty.builder()
                 .logGroupName("logGroupName")
                 .logRoleArn("logRoleArn")
                 .build())
         .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	CfnResourceVersionProps.Builder	A builder for CfnResourceVersionProps
static final class	CfnResourceVersionProps.Jsii$Proxy	An implementation for CfnResourceVersionProps

Method Summary

Modifier and Type	Method	Description
static CfnResourceVersionProps.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.
String	getSchemaHandlerPackage()	A URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register.
String	getTypeName()	The name of the resource being registered.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSchemaHandlerPackage

@Stability(Stable)
@NotNull
String getSchemaHandlerPackage()

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 .

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 .

See Also:

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

getTypeName

@Stability(Stable)
@NotNull
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

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.

See Also:

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

builder

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

Returns:

a CfnResourceVersionProps.Builder of CfnResourceVersionProps