software.amazon.awscdk.services.greengrass

Class CfnGroupVersion

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.greengrass.CfnGroupVersion

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:35.176Z")
 @Stability(value=Stable)
public class CfnGroupVersion
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Greengrass::GroupVersion`.

The AWS::Greengrass::GroupVersion resource represents a group version in AWS IoT Greengrass . A group version references a core definition version, device definition version, subscription definition version, and other version types that contain the components you want to deploy to a Greengrass core device. 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 create a group version, you must specify the ID of the group that you want to associate with the version. For information about creating a group, 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.*;
 CfnGroupVersion cfnGroupVersion = CfnGroupVersion.Builder.create(this, "MyCfnGroupVersion")
         .groupId("groupId")
         // the properties below are optional
         .connectorDefinitionVersionArn("connectorDefinitionVersionArn")
         .coreDefinitionVersionArn("coreDefinitionVersionArn")
         .deviceDefinitionVersionArn("deviceDefinitionVersionArn")
         .functionDefinitionVersionArn("functionDefinitionVersionArn")
         .loggerDefinitionVersionArn("loggerDefinitionVersionArn")
         .resourceDefinitionVersionArn("resourceDefinitionVersionArn")
         .subscriptionDefinitionVersionArn("subscriptionDefinitionVersionArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnGroupVersion.Builder A fluent builder for CfnGroupVersion.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnGroupVersion(Construct scope, String id, CfnGroupVersionProps props) Create a new `AWS::Greengrass::GroupVersion`.
protected	CfnGroupVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGroupVersion(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getConnectorDefinitionVersionArn() The Amazon Resource Name (ARN) of the connector definition version that contains the connectors you want to deploy with the group version.
String	getCoreDefinitionVersionArn() The ARN of the core definition version that contains the core you want to deploy with the group version.
String	getDeviceDefinitionVersionArn() The ARN of the device definition version that contains the devices you want to deploy with the group version.
String	getFunctionDefinitionVersionArn() The ARN of the function definition version that contains the functions you want to deploy with the group version.
String	getGroupId() The ID of the group associated with this version.
String	getLoggerDefinitionVersionArn() The ARN of the logger definition version that contains the loggers you want to deploy with the group version.
String	getResourceDefinitionVersionArn() The ARN of the resource definition version that contains the resources you want to deploy with the group version.
String	getSubscriptionDefinitionVersionArn() The ARN of the subscription definition version that contains the subscriptions you want to deploy with the group version.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConnectorDefinitionVersionArn(String value) The Amazon Resource Name (ARN) of the connector definition version that contains the connectors you want to deploy with the group version.
void	setCoreDefinitionVersionArn(String value) The ARN of the core definition version that contains the core you want to deploy with the group version.
void	setDeviceDefinitionVersionArn(String value) The ARN of the device definition version that contains the devices you want to deploy with the group version.
void	setFunctionDefinitionVersionArn(String value) The ARN of the function definition version that contains the functions you want to deploy with the group version.
void	setGroupId(String value) The ID of the group associated with this version.
void	setLoggerDefinitionVersionArn(String value) The ARN of the logger definition version that contains the loggers you want to deploy with the group version.
void	setResourceDefinitionVersionArn(String value) The ARN of the resource definition version that contains the resources you want to deploy with the group version.
void	setSubscriptionDefinitionVersionArn(String value) The ARN of the subscription definition version that contains the subscriptions you want to deploy with the group version.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnGroupVersion

protected CfnGroupVersion(software.amazon.jsii.JsiiObjectRef objRef)

CfnGroupVersion

protected CfnGroupVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnGroupVersion

@Stability(value=Stable)
public CfnGroupVersion(@NotNull
                                                Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnGroupVersionProps props)

Create a new `AWS::Greengrass::GroupVersion`.

Parameters:

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.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getGroupId

@Stability(value=Stable)
 @NotNull
public String getGroupId()

The ID of the group associated with this version.

This value is a GUID.

setGroupId

@Stability(value=Stable)
public void setGroupId(@NotNull
                                                String value)

The ID of the group associated with this version.

This value is a GUID.

getConnectorDefinitionVersionArn

@Stability(value=Stable)
 @Nullable
public String getConnectorDefinitionVersionArn()

The Amazon Resource Name (ARN) of the connector definition version that contains the connectors you want to deploy with the group version.

setConnectorDefinitionVersionArn

@Stability(value=Stable)
public void setConnectorDefinitionVersionArn(@Nullable
                                                                      String value)

The Amazon Resource Name (ARN) of the connector definition version that contains the connectors you want to deploy with the group version.

getCoreDefinitionVersionArn

@Stability(value=Stable)
 @Nullable
public String getCoreDefinitionVersionArn()

The ARN of the core definition version that contains the core you want to deploy with the group version.

Currently, the core definition version can contain only one core.

setCoreDefinitionVersionArn

@Stability(value=Stable)
public void setCoreDefinitionVersionArn(@Nullable
                                                                 String value)

The ARN of the core definition version that contains the core you want to deploy with the group version.

Currently, the core definition version can contain only one core.

getDeviceDefinitionVersionArn

@Stability(value=Stable)
 @Nullable
public String getDeviceDefinitionVersionArn()

The ARN of the device definition version that contains the devices you want to deploy with the group version.

setDeviceDefinitionVersionArn

@Stability(value=Stable)
public void setDeviceDefinitionVersionArn(@Nullable
                                                                   String value)

The ARN of the device definition version that contains the devices you want to deploy with the group version.

getFunctionDefinitionVersionArn

@Stability(value=Stable)
 @Nullable
public String getFunctionDefinitionVersionArn()

The ARN of the function definition version that contains the functions you want to deploy with the group version.

setFunctionDefinitionVersionArn

@Stability(value=Stable)
public void setFunctionDefinitionVersionArn(@Nullable
                                                                     String value)

The ARN of the function definition version that contains the functions you want to deploy with the group version.

getLoggerDefinitionVersionArn

@Stability(value=Stable)
 @Nullable
public String getLoggerDefinitionVersionArn()

The ARN of the logger definition version that contains the loggers you want to deploy with the group version.

setLoggerDefinitionVersionArn

@Stability(value=Stable)
public void setLoggerDefinitionVersionArn(@Nullable
                                                                   String value)

The ARN of the logger definition version that contains the loggers you want to deploy with the group version.

getResourceDefinitionVersionArn

@Stability(value=Stable)
 @Nullable
public String getResourceDefinitionVersionArn()

The ARN of the resource definition version that contains the resources you want to deploy with the group version.

setResourceDefinitionVersionArn

@Stability(value=Stable)
public void setResourceDefinitionVersionArn(@Nullable
                                                                     String value)

The ARN of the resource definition version that contains the resources you want to deploy with the group version.

getSubscriptionDefinitionVersionArn

@Stability(value=Stable)
 @Nullable
public String getSubscriptionDefinitionVersionArn()

The ARN of the subscription definition version that contains the subscriptions you want to deploy with the group version.

setSubscriptionDefinitionVersionArn

@Stability(value=Stable)
public void setSubscriptionDefinitionVersionArn(@Nullable
                                                                         String value)

The ARN of the subscription definition version that contains the subscriptions you want to deploy with the group version.