CfnGroupProps

class aws_cdk.aws_greengrass.CfnGroupProps(*, name, initial_version=None, role_arn=None, tags=None)

Bases: object

Properties for defining a CfnGroup.

Parameters
  • name (str) – The name of the group.

  • initial_version (Union[IResolvable, GroupVersionProperty, Dict[str, Any], None]) – The group version to include when the group is created. A group version references the Amazon Resource Name (ARN) of a core definition version, device definition version, subscription definition version, and other version types. The group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need. .. epigraph:: To associate a group version after the group is created, create an `AWS::Greengrass::GroupVersion <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html>`_ resource and specify the ID of this group.

  • role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role attached to the group. This role contains the permissions that Lambda functions and connectors use to interact with other AWS services.

  • tags (Optional[Any]) – Application-specific metadata to attach to the group. 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” }

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html

ExampleMetadata

fixture=_generated

Example:

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

# tags: Any

cfn_group_props = greengrass.CfnGroupProps(
    name="name",

    # the properties below are optional
    initial_version=greengrass.CfnGroup.GroupVersionProperty(
        connector_definition_version_arn="connectorDefinitionVersionArn",
        core_definition_version_arn="coreDefinitionVersionArn",
        device_definition_version_arn="deviceDefinitionVersionArn",
        function_definition_version_arn="functionDefinitionVersionArn",
        logger_definition_version_arn="loggerDefinitionVersionArn",
        resource_definition_version_arn="resourceDefinitionVersionArn",
        subscription_definition_version_arn="subscriptionDefinitionVersionArn"
    ),
    role_arn="roleArn",
    tags=tags
)

Attributes

initial_version

The group version to include when the group is created.

A group version references the Amazon Resource Name (ARN) of a core definition version, device definition version, subscription definition version, and other version types. The group version must reference a core definition version that contains one core. Other version types are optionally included, depending on your business need. .. epigraph:

To associate a group version after the group is created, create an ```AWS::Greengrass::GroupVersion`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-groupversion.html>`_ resource and specify the ID of this group.
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-initialversion

Return type

Union[IResolvable, GroupVersionProperty, None]

name

The name of the group.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-name

Return type

str

role_arn

The Amazon Resource Name (ARN) of the IAM role attached to the group.

This role contains the permissions that Lambda functions and connectors use to interact with other AWS services.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-rolearn

Return type

Optional[str]

tags

Application-specific metadata to attach to the group.

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"
}
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html#cfn-greengrass-group-tags

Return type

Any