Class CfnConnectorDefinition

A CloudFormation AWS::Greengrass::ConnectorDefinition.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnConnectorDefinition
Implements
Constructs.IConstruct
Inherited Members
Namespace: Amazon.CDK.AWS.Greengrass
Assembly: Amazon.CDK.AWS.Greengrass.dll
Syntax (csharp)
public class CfnConnectorDefinition : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnConnectorDefinition
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
Remarks

The AWS::Greengrass::ConnectorDefinition resource represents a connector definition for AWS IoT Greengrass . Connector definitions are used to organize your connector definition versions.

Connector definitions can reference multiple connector definition versions. All connector definition versions must be associated with a connector definition. Each connector definition version can contain one or more connectors.

When you create a connector definition, you can optionally include an initial connector definition version. To associate a connector definition version later, create an AWS::Greengrass::ConnectorDefinitionVersion resource and specify the ID of this connector definition.

After you create the connector definition version that contains the connectors you want to deploy, you must add it to your group version. For more information, see AWS::Greengrass::Group .

CloudformationResource: AWS::Greengrass::ConnectorDefinition

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.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.Greengrass;

var parameters;
var tags;

var cfnConnectorDefinition = new CfnConnectorDefinition(this, "MyCfnConnectorDefinition", new CfnConnectorDefinitionProps {
    Name = "name",

    // the properties below are optional
    InitialVersion = new ConnectorDefinitionVersionProperty {
        Connectors = new [] { new ConnectorProperty {
            ConnectorArn = "connectorArn",
            Id = "id",

            // the properties below are optional
            Parameters = parameters
        } }
    },
    Tags = tags
});

Synopsis

Constructors

CfnConnectorDefinition(Construct, String, ICfnConnectorDefinitionProps)

Create a new AWS::Greengrass::ConnectorDefinition.
CfnConnectorDefinition(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnConnectorDefinition(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

AttrArn

The Amazon Resource Name (ARN) of the ConnectorDefinition , such as arn:aws:greengrass:us-east-1: :/greengrass/definition/connectors/1234a5b6-78cd-901e-2fgh-3i45j6k178l9 .
AttrId

The ID of the ConnectorDefinition , such as 1234a5b6-78cd-901e-2fgh-3i45j6k178l9 .
AttrLatestVersionArn

The ARN of the last ConnectorDefinitionVersion that was added to the ConnectorDefinition , such as arn:aws:greengrass:us-east-1: :/greengrass/definition/connectors/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2 .
AttrName

The name of the ConnectorDefinition , such as MyConnectorDefinition .
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
InitialVersion

The connector definition version to include when the connector definition is created.
Name

The name of the connector definition.
Tags

Application-specific metadata to attach to the connector definition.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnConnectorDefinition(Construct, String, ICfnConnectorDefinitionProps)

Create a new AWS::Greengrass::ConnectorDefinition.

public CfnConnectorDefinition(Construct scope, string id, ICfnConnectorDefinitionProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnConnectorDefinitionProps
  • resource properties.

CfnConnectorDefinition(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnConnectorDefinition(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnConnectorDefinition(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnConnectorDefinition(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

AttrArn

The Amazon Resource Name (ARN) of the ConnectorDefinition , such as arn:aws:greengrass:us-east-1: :/greengrass/definition/connectors/1234a5b6-78cd-901e-2fgh-3i45j6k178l9 .

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Arn

AttrId

The ID of the ConnectorDefinition , 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 ConnectorDefinitionVersion that was added to the ConnectorDefinition , such as arn:aws:greengrass:us-east-1: :/greengrass/definition/connectors/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 ConnectorDefinition , such as MyConnectorDefinition .

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 connector definition version to include when the connector definition is created.

public virtual object InitialVersion { get; set; }
Property Value

System.Object

Remarks

A connector definition version contains a list of connector property types.

To associate a connector definition version after the connector definition is created, create an AWS::Greengrass::ConnectorDefinitionVersion resource and specify the ID of this connector definition.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#cfn-greengrass-connectordefinition-initialversion

Name

The name of the connector definition.

public virtual string Name { get; set; }
Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#cfn-greengrass-connectordefinition-name

Tags

Application-specific metadata to attach to the connector definition.

public virtual TagManager Tags { get; }
Property Value

TagManager

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"
}

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html#cfn-greengrass-connectordefinition-tags

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>

Overrides

Implements

Constructs.IConstruct