Class CfnSubscriptionDefinition
A CloudFormation AWS::Greengrass::SubscriptionDefinition
.
Inherited Members
Namespace: Amazon.CDK.AWS.Greengrass
Assembly: Amazon.CDK.AWS.Greengrass.dll
Syntax (csharp)
public class CfnSubscriptionDefinition : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnSubscriptionDefinition
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Greengrass::SubscriptionDefinition
resource represents a subscription definition for AWS IoT Greengrass . Subscription definitions are used to organize your subscription definition versions.
Subscription definitions can reference multiple subscription definition versions. All subscription definition versions must be associated with a subscription definition. Each subscription definition version can contain one or more subscriptions.
When you create a subscription definition, you can optionally include an initial subscription definition version. To associate a subscription definition version later, create an AWS::Greengrass::SubscriptionDefinitionVersion
resource and specify the ID of this subscription definition.
After you create the subscription definition version that contains the subscriptions you want to deploy, you must add it to your group version. For more information, see AWS::Greengrass::Group
.
CloudformationResource: AWS::Greengrass::SubscriptionDefinition
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 cfnSubscriptionDefinition = new CfnSubscriptionDefinition(this, "MyCfnSubscriptionDefinition", new CfnSubscriptionDefinitionProps {
Name = "name",
// the properties below are optional
InitialVersion = new SubscriptionDefinitionVersionProperty {
Subscriptions = new [] { new SubscriptionProperty {
Id = "id",
Source = "source",
Subject = "subject",
Target = "target"
} }
},
Tags = tags
});
Synopsis
Constructors
CfnSubscriptionDefinition(Construct, String, ICfnSubscriptionDefinitionProps) | Create a new |
CfnSubscriptionDefinition(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSubscriptionDefinition(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 subscription definition version to include when the subscription definition is created. |
Name | The name of the subscription definition. |
Tags | Application-specific metadata to attach to the subscription definition. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSubscriptionDefinition(Construct, String, ICfnSubscriptionDefinitionProps)
Create a new AWS::Greengrass::SubscriptionDefinition
.
public CfnSubscriptionDefinition(Construct scope, string id, ICfnSubscriptionDefinitionProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnSubscriptionDefinitionProps
- resource properties.
CfnSubscriptionDefinition(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSubscriptionDefinition(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSubscriptionDefinition(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSubscriptionDefinition(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the SubscriptionDefinition
, such as arn:aws:greengrass:us-east-1: :/greengrass/definition/subscriptions/1234a5b6-78cd-901e-2fgh-3i45j6k178l9
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrId
The ID of the SubscriptionDefinition
, 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 SubscriptionDefinitionVersion
that was added to the SubscriptionDefinition
, such as arn:aws:greengrass:us-east-1: :/greengrass/definition/subscriptions/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 SubscriptionDefinition
, such as MySubscriptionDefinition
.
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 subscription definition version to include when the subscription definition is created.
public virtual object InitialVersion { get; set; }
Property Value
System.Object
Remarks
A subscription definition version contains a list of subscription
property types.
To associate a subscription definition version after the subscription definition is created, create an AWS::Greengrass::SubscriptionDefinitionVersion
resource and specify the ID of this subscription definition.
Name
The name of the subscription definition.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Tags
Application-specific metadata to attach to the subscription 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>