Class CfnResourceVersion
Registers a resource version with the CloudFormation service.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.CloudFormation
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnResourceVersion : CfnResource, IInspectable
Syntax (vb)
Public Class CfnResourceVersion
Inherits CfnResource
Implements IInspectable
Remarks
Registering a resource version makes it available for use in CloudFormation templates in your AWS account , and includes:
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
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFormation;
var cfnResourceVersion = new CfnResourceVersion(this, "MyCfnResourceVersion", new CfnResourceVersionProps {
SchemaHandlerPackage = "schemaHandlerPackage",
TypeName = "typeName",
// the properties below are optional
ExecutionRoleArn = "executionRoleArn",
LoggingConfig = new LoggingConfigProperty {
LogGroupName = "logGroupName",
LogRoleArn = "logRoleArn"
}
});
Synopsis
Constructors
CfnResourceVersion(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnResourceVersion(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnResourceVersion(Construct, String, ICfnResourceVersionProps) |
Properties
AttrArn | The Amazon Resource Name (ARN) of the extension. |
AttrIsDefaultVersion | Whether the specified extension version is set as the default version. |
AttrProvisioningType | For resource type extensions, the provisioning behavior of the resource type. |
AttrTypeArn | The Amazon Resource Name (ARN) of the extension. |
AttrVersionId | The ID of a specific version of the extension. |
AttrVisibility | The scope at which the extension is visible and usable in CloudFormation operations. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ExecutionRoleArn | The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource. |
LoggingConfig | Logging configuration information for a resource. |
SchemaHandlerPackage | A URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register. |
TypeName | The name of the resource being registered. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnResourceVersion(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnResourceVersion(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnResourceVersion(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnResourceVersion(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnResourceVersion(Construct, String, ICfnResourceVersionProps)
public CfnResourceVersion(Construct scope, string id, ICfnResourceVersionProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnResourceVersionProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) of the extension.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrIsDefaultVersion
Whether the specified extension version is set as the default version.
public virtual IResolvable AttrIsDefaultVersion { get; }
Property Value
Remarks
This applies only to private extensions you have registered in your account, and extensions published by AWS . For public third-party extensions, whether they are activated in your account, CloudFormation returns null
.
CloudformationAttribute: IsDefaultVersion
AttrProvisioningType
For resource type extensions, the provisioning behavior of the resource type.
public virtual string AttrProvisioningType { get; }
Property Value
System.String
Remarks
AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.
Valid values include:
CloudformationAttribute: ProvisioningType
AttrTypeArn
The Amazon Resource Name (ARN) of the extension.
public virtual string AttrTypeArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: TypeArn
AttrVersionId
The ID of a specific version of the extension.
public virtual string AttrVersionId { get; }
Property Value
System.String
Remarks
The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.
If you specify a VersionId
, DescribeType
returns information about that specific extension version. Otherwise, it returns information about the default extension version.
CloudformationAttribute: VersionId
AttrVisibility
The scope at which the extension is visible and usable in CloudFormation operations.
public virtual string AttrVisibility { get; }
Property Value
System.String
Remarks
Valid values include:
CloudformationAttribute: Visibility
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ExecutionRoleArn
The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource.
public virtual string ExecutionRoleArn { get; set; }
Property Value
System.String
LoggingConfig
Logging configuration information for a resource.
public virtual object LoggingConfig { get; set; }
Property Value
System.Object
SchemaHandlerPackage
A URL to the S3 bucket containing the resource project package that contains the necessary files for the resource you want to register.
public virtual string SchemaHandlerPackage { get; set; }
Property Value
System.String
TypeName
The name of the resource being registered.
public virtual string TypeName { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>