@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:46.546Z") public class CfnConnectorDefinition extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnConnectorDefinition(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.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` .
|
java.lang.String |
getAttrId()
The ID of the `ConnectorDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
|
java.lang.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` .
|
java.lang.String |
getAttrName()
The name of the `ConnectorDefinition` , such as `MyConnectorDefinition` .
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getInitialVersion()
The connector definition version to include when the connector definition is created.
|
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.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(java.lang.String value)
The name of the connector definition.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnConnectorDefinition(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnConnectorDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnConnectorDefinition(Construct scope, java.lang.String id, CfnConnectorDefinitionProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrId()
public java.lang.String getAttrLatestVersionArn()
public java.lang.String getAttrName()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
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" }
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.Object getInitialVersion()
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.
public void setInitialVersion(CfnConnectorDefinition.ConnectorDefinitionVersionProperty value)
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.
public void setInitialVersion(IResolvable value)
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.