Package software.amazon.awscdk.services.greengrass

Interface CfnGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2025-02-26T00:07:39.005Z")
@Stability(Stable)
public interface CfnGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnGroup.

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 tags;
 CfnGroupProps cfnGroupProps = CfnGroupProps.builder()
         .name("name")
         // the properties below are optional
         .initialVersion(GroupVersionProperty.builder()
                 .connectorDefinitionVersionArn("connectorDefinitionVersionArn")
                 .coreDefinitionVersionArn("coreDefinitionVersionArn")
                 .deviceDefinitionVersionArn("deviceDefinitionVersionArn")
                 .functionDefinitionVersionArn("functionDefinitionVersionArn")
                 .loggerDefinitionVersionArn("loggerDefinitionVersionArn")
                 .resourceDefinitionVersionArn("resourceDefinitionVersionArn")
                 .subscriptionDefinitionVersionArn("subscriptionDefinitionVersionArn")
                 .build())
         .roleArn("roleArn")
         .tags(tags)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGroupProps.Builder	A builder for CfnGroupProps
static final class	CfnGroupProps.Jsii$Proxy	An implementation for CfnGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnGroupProps.Builder	builder()
default Object	getInitialVersion()	The group version to include when the group is created.
String	getName()	The name of the group.
default String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role attached to the group.
default Object	getTags()	Application-specific metadata to attach to the group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the group.

See Also:

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

getInitialVersion

@Stability(Stable)
@Nullable
default Object getInitialVersion()

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.

To associate a group version after the group is created, create an AWS::Greengrass::GroupVersion resource and specify the ID of this group.

See Also:

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

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Object getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnGroupProps.Builder builder()

Returns:

a CfnGroupProps.Builder of CfnGroupProps