Class CfnResourceVersion
A CloudFormation AWS::CloudFormation::ResourceVersion
.
Inherited Members
Namespace: Amazon.CDK
Assembly: Amazon.CDK.dll
Syntax (csharp)
public class CfnResourceVersion : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnResourceVersion
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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:
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;
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(Construct, String, ICfnResourceVersionProps) | Create a new |
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 |
Properties
AttrArn | The Amazon Resource Name (ARN) of the resource version. |
AttrIsDefaultVersion | Whether the resource version is set as the default version. |
AttrProvisioningType | The provisioning behavior of the resource type. |
AttrTypeArn | The Amazon Resource Name (ARN) of the resource. |
AttrVersionId | The ID of a specific version of the resource. |
AttrVisibility | The scope at which the resource 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(Construct, String, ICfnResourceVersionProps)
Create a new AWS::CloudFormation::ResourceVersion
.
public CfnResourceVersion(Construct scope, string id, ICfnResourceVersionProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnResourceVersionProps
- resource properties.
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
Properties
AttrArn
The Amazon Resource Name (ARN) of the resource version.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrIsDefaultVersion
Whether the resource version is set as the default version.
public virtual IResolvable AttrIsDefaultVersion { get; }
Property Value
Remarks
CloudformationAttribute: IsDefaultVersion
AttrProvisioningType
The provisioning behavior of the resource type.
public virtual string AttrProvisioningType { get; }
Property Value
System.String
Remarks
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 resource.
public virtual string AttrTypeArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: TypeArn
AttrVersionId
The ID of a specific version of the resource.
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 resource version when it is registered.
CloudformationAttribute: VersionId
AttrVisibility
The scope at which the resource 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
Remarks
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.
LoggingConfig
Logging configuration information for a resource.
public virtual object LoggingConfig { get; set; }
Property Value
System.Object
Remarks
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
Remarks
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 .
TypeName
The name of the resource being registered.
public virtual string TypeName { get; set; }
Property Value
System.String
Remarks
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:
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>