Package 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:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.007Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnGroupVersion

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

    • CfnGroupVersion

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

    • CfnGroupVersion

      @Stability(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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getGroupId

      @Stability(Stable) @NotNull public String getGroupId()
      The ID of the group associated with this version.

      This value is a GUID.

    • setGroupId

      @Stability(Stable) public void setGroupId(@NotNull String value)
      The ID of the group associated with this version.

      This value is a GUID.

    • getConnectorDefinitionVersionArn

      @Stability(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(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(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(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(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(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(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(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(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(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(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(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(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(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.