Class CfnCoreDefinition
A CloudFormation AWS::Greengrass::CoreDefinition
.
Inherited Members
Namespace: Amazon.CDK.AWS.Greengrass
Assembly: Amazon.CDK.AWS.Greengrass.dll
Syntax (csharp)
public class CfnCoreDefinition : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnCoreDefinition
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Greengrass::CoreDefinition
resource represents a core definition for AWS IoT Greengrass . Core definitions are used to organize your core definition versions.
Core definitions can reference multiple core definition versions. All core definition versions must be associated with a core definition. Each core definition version can contain one Greengrass core.
When you create a core definition, you can optionally include an initial core definition version. To associate a core definition version later, create an AWS::Greengrass::CoreDefinitionVersion
resource and specify the ID of this core definition.
After you create the core definition version that contains the core you want to deploy, you must add it to your group version. For more information, see AWS::Greengrass::Group
.
CloudformationResource: AWS::Greengrass::CoreDefinition
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.Greengrass;
var tags;
var cfnCoreDefinition = new CfnCoreDefinition(this, "MyCfnCoreDefinition", new CfnCoreDefinitionProps {
Name = "name",
// the properties below are optional
InitialVersion = new CoreDefinitionVersionProperty {
Cores = new [] { new CoreProperty {
CertificateArn = "certificateArn",
Id = "id",
ThingArn = "thingArn",
// the properties below are optional
SyncShadow = false
} }
},
Tags = tags
});
Synopsis
Constructors
CfnCoreDefinition(Construct, String, ICfnCoreDefinitionProps) | Create a new |
CfnCoreDefinition(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCoreDefinition(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Name (ARN) of the |
AttrId | The ID of the |
AttrLatestVersionArn | The ARN of the last |
AttrName | The name of the |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
InitialVersion | The core definition version to include when the core definition is created. |
Name | The name of the core definition. |
Tags | Application-specific metadata to attach to the core definition. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCoreDefinition(Construct, String, ICfnCoreDefinitionProps)
Create a new AWS::Greengrass::CoreDefinition
.
public CfnCoreDefinition(Construct scope, string id, ICfnCoreDefinitionProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnCoreDefinitionProps
- resource properties.
CfnCoreDefinition(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCoreDefinition(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCoreDefinition(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCoreDefinition(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the CoreDefinition
, such as arn:aws:greengrass:us-east-1: :/greengrass/definition/cores/1234a5b6-78cd-901e-2fgh-3i45j6k178l9
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrId
The ID of the CoreDefinition
, such as 1234a5b6-78cd-901e-2fgh-3i45j6k178l9
.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrLatestVersionArn
The ARN of the last CoreDefinitionVersion
that was added to the CoreDefinition
, such as arn:aws:greengrass:us-east-1: :/greengrass/definition/cores/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2
.
public virtual string AttrLatestVersionArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LatestVersionArn
AttrName
The name of the CoreDefinition
, such as MyCoreDefinition
.
public virtual string AttrName { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Name
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
InitialVersion
The core definition version to include when the core definition is created.
public virtual object InitialVersion { get; set; }
Property Value
System.Object
Remarks
Currently, a core definition version can contain only one core
.
To associate a core definition version after the core definition is created, create an AWS::Greengrass::CoreDefinitionVersion
resource and specify the ID of this core definition.
Name
The name of the core definition.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Tags
Application-specific metadata to attach to the core definition.
public virtual TagManager Tags { get; }
Property Value
Remarks
You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tagging Your AWS IoT Greengrass Resources in the Developer Guide .
This Json
property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags
implementations in AWS CloudFormation templates.
"Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
}
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>