Class CfnSchema
A CloudFormation AWS::EventSchemas::Schema
.
Inherited Members
Namespace: Amazon.CDK.AWS.EventSchemas
Assembly: Amazon.CDK.AWS.EventSchemas.dll
Syntax (csharp)
public class CfnSchema : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnSchema
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Use the AWS::EventSchemas::Schema
resource to specify an event schema.
CloudformationResource: AWS::EventSchemas::Schema
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eventschemas-schema.html
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.EventSchemas;
var cfnSchema = new CfnSchema(this, "MyCfnSchema", new CfnSchemaProps {
Content = "content",
RegistryName = "registryName",
Type = "type",
// the properties below are optional
Description = "description",
SchemaName = "schemaName",
Tags = new [] { new TagsEntryProperty {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnSchema(Construct, String, ICfnSchemaProps) | Create a new |
CfnSchema(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSchema(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrSchemaArn | The ARN of the schema. |
AttrSchemaName | The name of the schema. |
AttrSchemaVersion | The version number of the schema. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Content | The source of the schema definition. |
Description | A description of the schema. |
RegistryName | The name of the schema registry. |
SchemaName | The name of the schema. |
Tags | Tags associated with the schema. |
Type | The type of schema. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSchema(Construct, String, ICfnSchemaProps)
Create a new AWS::EventSchemas::Schema
.
public CfnSchema(Construct scope, string id, ICfnSchemaProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnSchemaProps
- resource properties.
CfnSchema(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSchema(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSchema(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSchema(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrSchemaArn
The ARN of the schema.
public virtual string AttrSchemaArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SchemaArn
AttrSchemaName
The name of the schema.
public virtual string AttrSchemaName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SchemaName
AttrSchemaVersion
The version number of the schema.
public virtual string AttrSchemaVersion { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SchemaVersion
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
Content
The source of the schema definition.
public virtual string Content { get; set; }
Property Value
System.String
Remarks
Description
A description of the schema.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
RegistryName
The name of the schema registry.
public virtual string RegistryName { get; set; }
Property Value
System.String
Remarks
SchemaName
The name of the schema.
public virtual string SchemaName { get; set; }
Property Value
System.String
Remarks
Tags
Tags associated with the schema.
public virtual TagManager Tags { get; }
Property Value
Remarks
Type
The type of schema.
public virtual string Type { get; set; }
Property Value
System.String
Remarks
Valid types include OpenApi3
and JSONSchemaDraft4
.
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>