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:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:35.056Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnConnectorDefinition.Builder A fluent builder for CfnConnectorDefinition.
static interface	CfnConnectorDefinition.ConnectorDefinitionVersionProperty A connector definition version contains a list of connectors.
static interface	CfnConnectorDefinition.ConnectorProperty Connectors are modules that provide built-in integration with local infrastructure, device protocols, AWS , and other cloud services.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConnectorDefinition(Construct scope, String id, CfnConnectorDefinitionProps props) Create a new `AWS::Greengrass::ConnectorDefinition`.
protected	CfnConnectorDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConnectorDefinition(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
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` .
String	getAttrId() The ID of the `ConnectorDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
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` .
String	getAttrName() The name of the `ConnectorDefinition` , such as `MyConnectorDefinition` .
protected Map<String,Object>	getCfnProperties()
Object	getInitialVersion() The connector definition version to include when the connector definition is created.
String	getName() The name of the connector definition.
TagManager	getTags() Application-specific metadata to attach to the connector definition.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setInitialVersion(CfnConnectorDefinition.ConnectorDefinitionVersionProperty value) The connector definition version to include when the connector definition is created.
void	setInitialVersion(IResolvable value) The connector definition version to include when the connector definition is created.
void	setName(String value) The name of the connector definition.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnConnectorDefinition

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

CfnConnectorDefinition

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

CfnConnectorDefinition

@Stability(value=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 Detail

inspect

@Stability(value=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(value=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(value=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(value=Stable)
 @NotNull
public String getAttrId()

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

getAttrLatestVersionArn

@Stability(value=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(value=Stable)
 @NotNull
public String getAttrName()

The name of the `ConnectorDefinition` , such as `MyConnectorDefinition` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=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(value=Stable)
 @NotNull
public String getName()

The name of the connector definition.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the connector definition.

getInitialVersion

@Stability(value=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(value=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(value=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.