software.amazon.awscdk.services.greengrass

Class CfnConnectorDefinitionVersion

java.lang.Object

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.CfnConnectorDefinitionVersion

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:15.012Z")
public class CfnConnectorDefinitionVersion
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Greengrass::ConnectorDefinitionVersion`.

The AWS::Greengrass::ConnectorDefinitionVersion resource represents a connector definition version for AWS IoT Greengrass . A connector definition version contains a list of connectors.

To create a connector definition version, you must specify the ID of the connector definition that you want to associate with the version. For information about creating a connector definition, see AWS::Greengrass::ConnectorDefinition .

After you create a 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;
 CfnConnectorDefinitionVersion cfnConnectorDefinitionVersion = CfnConnectorDefinitionVersion.Builder.create(this, "MyCfnConnectorDefinitionVersion")
         .connectorDefinitionId("connectorDefinitionId")
         .connectors(List.of(ConnectorProperty.builder()
                 .connectorArn("connectorArn")
                 .id("id")
                 // the properties below are optional
                 .parameters(parameters)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnConnectorDefinitionVersion.Builder A fluent builder for CfnConnectorDefinitionVersion.
static interface	CfnConnectorDefinitionVersion.ConnectorProperty Connectors are modules that provide built-in integration with local infrastructure, device protocols, AWS , and other cloud services.

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 java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnConnectorDefinitionVersion(Construct scope, java.lang.String id, CfnConnectorDefinitionVersionProps props) Create a new `AWS::Greengrass::ConnectorDefinitionVersion`.
protected	CfnConnectorDefinitionVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConnectorDefinitionVersion(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getConnectorDefinitionId() The ID of the connector definition associated with this version.
java.lang.Object	getConnectors() The connectors in this version.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setConnectorDefinitionId(java.lang.String value) The ID of the connector definition associated with this version.
void	setConnectors(IResolvable value) The connectors in this version.
void	setConnectors(java.util.List<java.lang.Object> value) The connectors in this version.

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 java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnConnectorDefinitionVersion

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

CfnConnectorDefinitionVersion

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

CfnConnectorDefinitionVersion

public CfnConnectorDefinitionVersion(Construct scope,
                                     java.lang.String id,
                                     CfnConnectorDefinitionVersionProps props)

Create a new `AWS::Greengrass::ConnectorDefinitionVersion`.

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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConnectorDefinitionId

public java.lang.String getConnectorDefinitionId()

The ID of the connector definition associated with this version.

This value is a GUID.

setConnectorDefinitionId

public void setConnectorDefinitionId(java.lang.String value)

The ID of the connector definition associated with this version.

This value is a GUID.

getConnectors

public java.lang.Object getConnectors()

The connectors in this version.

Only one instance of a given connector can be added to the connector definition version at a time.

setConnectors

public void setConnectors(IResolvable value)

The connectors in this version.

Only one instance of a given connector can be added to the connector definition version at a time.

setConnectors

public void setConnectors(java.util.List<java.lang.Object> value)

The connectors in this version.

Only one instance of a given connector can be added to the connector definition version at a time.