Package software.amazon.awscdk.services.greengrass

Interface CfnConnectorDefinition.ConnectorProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConnectorDefinition.ConnectorProperty.Jsii$Proxy

Enclosing class:

CfnConnectorDefinition

@Stability(Stable)
public static interface CfnConnectorDefinition.ConnectorProperty
extends software.amazon.jsii.JsiiSerializable

Connectors are modules that provide built-in integration with local infrastructure, device protocols, AWS , and other cloud services.

For more information, see Integrate with Services and Protocols Using Greengrass Connectors in the Developer Guide .

In an AWS CloudFormation template, the Connectors property of the ConnectorDefinitionVersion property type contains a list of Connector property types.

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;
 ConnectorProperty connectorProperty = ConnectorProperty.builder()
         .connectorArn("connectorArn")
         .id("id")
         // the properties below are optional
         .parameters(parameters)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConnectorDefinition.ConnectorProperty.Builder	A builder for CfnConnectorDefinition.ConnectorProperty
static final class	CfnConnectorDefinition.ConnectorProperty.Jsii$Proxy	An implementation for CfnConnectorDefinition.ConnectorProperty

Method Summary

Modifier and Type	Method	Description
static CfnConnectorDefinition.ConnectorProperty.Builder	builder()
String	getConnectorArn()	The Amazon Resource Name (ARN) of the connector.
String	getId()	A descriptive or arbitrary ID for the connector.
default Object	getParameters()	The parameters or configuration used by the connector.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConnectorArn

@Stability(Stable)
@NotNull
String getConnectorArn()

The Amazon Resource Name (ARN) of the connector.

For more information about connectors provided by AWS , see Greengrass Connectors Provided by AWS .

getId

@Stability(Stable)
@NotNull
String getId()

A descriptive or arbitrary ID for the connector.

This value must be unique within the connector definition version. Maximum length is 128 characters with pattern [a-zA-Z0-9:_-]+ .

getParameters

@Stability(Stable)
@Nullable
default Object getParameters()

The parameters or configuration used by the connector.

For more information about connectors provided by AWS , see Greengrass Connectors Provided by AWS .

builder

@Stability(Stable)
static CfnConnectorDefinition.ConnectorProperty.Builder builder()

Returns:

a CfnConnectorDefinition.ConnectorProperty.Builder of CfnConnectorDefinition.ConnectorProperty