Package software.amazon.awscdk.services.greengrass

Class CfnConnectorDefinition

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.greengrass.CfnConnectorDefinition
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.941Z") @Stability(Stable) public class CfnConnectorDefinition extends CfnResource implements IInspectable
A CloudFormation AWS::Greengrass::ConnectorDefinition.

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 .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.greengrass.*;
 Object parameters;
 Object tags;
 CfnConnectorDefinition cfnConnectorDefinition = CfnConnectorDefinition.Builder.create(this, "MyCfnConnectorDefinition")
         .name("name")
         // the properties below are optional
         .initialVersion(ConnectorDefinitionVersionProperty.builder()
                 .connectors(List.of(ConnectorProperty.builder()
                         .connectorArn("connectorArn")
                         .id("id")
                         // the properties below are optional
                         .parameters(parameters)
                         .build()))
                 .build())
         .tags(tags)
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnConnectorDefinition

      protected CfnConnectorDefinition(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnConnectorDefinition

      protected CfnConnectorDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnConnectorDefinition

      @Stability(Stable) public CfnConnectorDefinition(@NotNull Construct scope, @NotNull String id, @NotNull CfnConnectorDefinitionProps props)
      Create a new AWS::Greengrass::ConnectorDefinition.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

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

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the ConnectorDefinition , such as 1234a5b6-78cd-901e-2fgh-3i45j6k178l9 .

    • getAttrLatestVersionArn

      @Stability(Stable) @NotNull public String getAttrLatestVersionArn()
      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 .

    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      The name of the ConnectorDefinition , such as MyConnectorDefinition .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Application-specific metadata to attach to the connector definition.

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

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the connector definition.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the connector definition.

    • getInitialVersion

      @Stability(Stable) @Nullable public Object getInitialVersion()
      The connector definition version to include when the connector definition is created.

      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.

    • setInitialVersion

      @Stability(Stable) public void setInitialVersion(@Nullable CfnConnectorDefinition.ConnectorDefinitionVersionProperty value)
      The connector definition version to include when the connector definition is created.

      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.

    • setInitialVersion

      @Stability(Stable) public void setInitialVersion(@Nullable IResolvable value)
      The connector definition version to include when the connector definition is created.

      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.