CfnConnectorDefinitionPropsMixin

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

Bases: Mixin

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. .. epigraph:

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`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinitionversion.html>`_ 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`` <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-connectordefinition.html
CloudformationResource:: AWS::Greengrass::ConnectorDefinition
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
# tags: Any

cfn_connector_definition_props_mixin = greengrass_mixins.CfnConnectorDefinitionPropsMixin(greengrass_mixins.CfnConnectorDefinitionMixinProps(
    initial_version=greengrass_mixins.CfnConnectorDefinitionPropsMixin.ConnectorDefinitionVersionProperty(
        connectors=[greengrass_mixins.CfnConnectorDefinitionPropsMixin.ConnectorProperty(
            connector_arn="connectorArn",
            id="id",
            parameters=parameters
        )]
    ),
    name="name",
    tags=tags
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnConnectorDefinitionMixinProps, 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 = ['initialVersion', 'name', 'tags']

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

ConnectorDefinitionVersionProperty

class CfnConnectorDefinitionPropsMixin.ConnectorDefinitionVersionProperty(*, connectors=None)

Bases: object

A connector definition version contains a list of connectors.

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>`_ .

In an CloudFormation template, ConnectorDefinitionVersion is the property type of the InitialVersion property in the `AWS::Greengrass::ConnectorDefinition <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-connectordefinition.html>`_ resource.

Parameters:: connectors (Union[IResolvable, Sequence[Union[IResolvable, ConnectorProperty, Dict[str, Any]]], None]) – The connectors in this version. Only one instance of a given connector can be added to a connector definition version at a time.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connectordefinitionversion.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_definition_version_property = greengrass_mixins.CfnConnectorDefinitionPropsMixin.ConnectorDefinitionVersionProperty(
    connectors=[greengrass_mixins.CfnConnectorDefinitionPropsMixin.ConnectorProperty(
        connector_arn="connectorArn",
        id="id",
        parameters=parameters
    )]
)

Attributes

connectors

The connectors in this version.

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

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

ConnectorProperty

class CfnConnectorDefinitionPropsMixin.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 `ConnectorDefinitionVersion <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-connectordefinition-connectordefinitionversion.html>`_ property type 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 used by 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-connectordefinition-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.CfnConnectorDefinitionPropsMixin.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-connectordefinition-connector.html#cfn-greengrass-connectordefinition-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-connectordefinition-connector.html#cfn-greengrass-connectordefinition-connector-id

parameters

The parameters or configuration used by 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-connectordefinition-connector.html#cfn-greengrass-connectordefinition-connector-parameters