CfnConnectorDefinitionVersionPropsMixin

class aws_cdk.mixins_preview.aws_greengrass.mixins.CfnConnectorDefinitionVersionPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::Greengrass::ConnectorDefinitionVersion resource represents a connector definition version for AWS IoT Greengrass .

A connector definition version contains a list of connectors. .. epigraph:

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`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html>`_ .

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`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html>`_ .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html
CloudformationResource:: AWS::Greengrass::ConnectorDefinitionVersion
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_greengrass import mixins as greengrass_mixins

# parameters: Any

cfn_connector_definition_version_props_mixin = greengrass_mixins.CfnConnectorDefinitionVersionPropsMixin(greengrass_mixins.CfnConnectorDefinitionVersionMixinProps(
    connector_definition_id="connectorDefinitionId",
    connectors=[greengrass_mixins.CfnConnectorDefinitionVersionPropsMixin.ConnectorProperty(
        connector_arn="connectorArn",
        id="id",
        parameters=parameters
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Greengrass::ConnectorDefinitionVersion.

Parameters:

props (Union[CfnConnectorDefinitionVersionMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['connectorDefinitionId', 'connectors']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ConnectorProperty

class CfnConnectorDefinitionVersionPropsMixin.ConnectorProperty(*, connector_arn=None, id=None, parameters=None)

Bases: object

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 CloudFormation template, the Connectors property of the `AWS::Greengrass::ConnectorDefinitionVersion <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html>`_ resource contains a list of Connector property types.

Parameters:

connector_arn (Optional[str]) – The Amazon Resource Name (ARN) of the connector. For more information about connectors provided by AWS , see Greengrass Connectors Provided by AWS .
id (Optional[str]) – 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:_-]+ .
parameters (Any) –
The parameters or configuration that the connector uses. For more information about connectors provided by AWS , see Greengrass Connectors Provided by AWS .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinitionversion-connector.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_greengrass import mixins as greengrass_mixins

# parameters: Any

connector_property = greengrass_mixins.CfnConnectorDefinitionVersionPropsMixin.ConnectorProperty(
    connector_arn="connectorArn",
    id="id",
    parameters=parameters
)

Attributes

connector_arn

The Amazon Resource Name (ARN) of the connector.

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinitionversion-connector.html#cfn-greengrass-connectordefinitionversion-connector-connectorarn

id

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:_-]+ .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinitionversion-connector.html#cfn-greengrass-connectordefinitionversion-connector-id

parameters

The parameters or configuration that the connector uses.

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinitionversion-connector.html#cfn-greengrass-connectordefinitionversion-connector-parameters