CfnResourceVersion

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.core.CfnResourceVersion

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:20.488Z")
public class CfnResourceVersion
extends CfnResource
implements IInspectable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.core.*;
 CfnResourceVersion cfnResourceVersion = CfnResourceVersion.Builder.create(this, "MyCfnResourceVersion")
         .schemaHandlerPackage("schemaHandlerPackage")
         .typeName("typeName")
         // the properties below are optional
         .executionRoleArn("executionRoleArn")
         .loggingConfig(LoggingConfigProperty.builder()
                 .logGroupName("logGroupName")
                 .logRoleArn("logRoleArn")
                 .build())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnResourceVersion.Builder` A fluent builder for `CfnResourceVersion`.
`static interface`	`CfnResourceVersion.LoggingConfigProperty` Logging configuration information for a resource.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnResourceVersion(Construct scope, java.lang.String id, CfnResourceVersionProps props)` Create a new `AWS::CloudFormation::ResourceVersion`.
`protected`	`CfnResourceVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnResourceVersion(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrArn()` The Amazon Resource Name (ARN) of the resource version.
`IResolvable`	`getAttrIsDefaultVersion()` Whether the resource version is set as the default version.
`java.lang.String`	`getAttrProvisioningType()` The provisioning behavior of the resource type.
`java.lang.String`	`getAttrTypeArn()` The Amazon Resource Name (ARN) of the resource.
`java.lang.String`	`getAttrVersionId()` The ID of a specific version of the resource.
`java.lang.String`	`getAttrVisibility()` The scope at which the resource is visible and usable in CloudFormation operations.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getExecutionRoleArn()` The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource.
`java.lang.Object`	`getLoggingConfig()` Logging configuration information for a resource.
`java.lang.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.
`java.lang.String`	`getTypeName()` The name of the resource being registered.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setExecutionRoleArn(java.lang.String value)` The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource.
`void`	`setLoggingConfig(CfnResourceVersion.LoggingConfigProperty value)` Logging configuration information for a resource.
`void`	`setLoggingConfig(IResolvable value)` Logging configuration information for a resource.
`void`	`setSchemaHandlerPackage(java.lang.String value)` A URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register.
`void`	`setTypeName(java.lang.String value)` The name of the resource being registered.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnResourceVersion
```
protected CfnResourceVersion(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnResourceVersion
```
protected CfnResourceVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnResourceVersion
```
public CfnResourceVersion(Construct scope,
                          java.lang.String id,
                          CfnResourceVersionProps props)
```
    Create a new `AWS::CloudFormation::ResourceVersion`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The Amazon Resource Name (ARN) of the resource version.
  - getAttrIsDefaultVersion
```
public IResolvable getAttrIsDefaultVersion()
```
    Whether the resource version is set as the default version.
  - getAttrProvisioningType
```
public java.lang.String getAttrProvisioningType()
```
    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
  - getAttrTypeArn
```
public java.lang.String getAttrTypeArn()
```
    The Amazon Resource Name (ARN) of the resource.
  - getAttrVersionId
```
public java.lang.String getAttrVersionId()
```
    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.
  - getAttrVisibility
```
public java.lang.String getAttrVisibility()
```
    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 as PRIVATE .
    - PUBLIC : The resource is publicly visible and usable within any Amazon account.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getSchemaHandlerPackage
```
public java.lang.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 .
  - setSchemaHandlerPackage
```
public void setSchemaHandlerPackage(java.lang.String value)
```
    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 .
  - getTypeName
```
public java.lang.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
  - setTypeName
```
public void setTypeName(java.lang.String value)
```
    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
  - getExecutionRoleArn
```
public java.lang.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.
  - setExecutionRoleArn
```
public void setExecutionRoleArn(java.lang.String value)
```
    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.
  - getLoggingConfig
```
public java.lang.Object getLoggingConfig()
```
    Logging configuration information for a resource.
  - setLoggingConfig
```
public void setLoggingConfig(IResolvable value)
```
    Logging configuration information for a resource.
  - setLoggingConfig
```
public void setLoggingConfig(CfnResourceVersion.LoggingConfigProperty value)
```
    Logging configuration information for a resource.

Class CfnResourceVersion

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnResourceVersion

CfnResourceVersion

CfnResourceVersion

Method Detail

inspect

renderProperties

getAttrArn

getAttrIsDefaultVersion

getAttrProvisioningType

getAttrTypeArn

getAttrVersionId

getAttrVisibility

getCfnProperties

getSchemaHandlerPackage

setSchemaHandlerPackage

getTypeName

setTypeName

getExecutionRoleArn

setExecutionRoleArn

getLoggingConfig

setLoggingConfig

setLoggingConfig