Package software.amazon.awscdk.services.greengrass

Class CfnCoreDefinition

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.greengrass.CfnCoreDefinition
All Implemented Interfaces:
IInspectable, ICoreDefinitionRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:37.599Z") @Stability(Stable) public class CfnCoreDefinition extends CfnResource implements IInspectable, ICoreDefinitionRef, ITaggable
The AWS::Greengrass::CoreDefinition resource represents a core definition for AWS IoT Greengrass .

Core definitions are used to organize your core definition versions.

Core definitions can reference multiple core definition versions. All core definition versions must be associated with a core definition. Each core definition version can contain one Greengrass core.

When you create a core definition, you can optionally include an initial core definition version. To associate a core definition version later, create an AWS::Greengrass::CoreDefinitionVersion resource and specify the ID of this core definition.

After you create the core definition version that contains the core you want to deploy, you must add it to your group version. For more information, 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.*;
 Object tags;
 CfnCoreDefinition cfnCoreDefinition = CfnCoreDefinition.Builder.create(this, "MyCfnCoreDefinition")
         .name("name")
         // the properties below are optional
         .initialVersion(CoreDefinitionVersionProperty.builder()
                 .cores(List.of(CoreProperty.builder()
                         .certificateArn("certificateArn")
                         .id("id")
                         .thingArn("thingArn")
                         // the properties below are optional
                         .syncShadow(false)
                         .build()))
                 .build())
         .tags(tags)
         .build();

See Also:

  • 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

    • CfnCoreDefinition

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

    • CfnCoreDefinition

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

    • CfnCoreDefinition

      @Stability(Stable) public CfnCoreDefinition(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCoreDefinitionProps props)
      Create a new AWS::Greengrass::CoreDefinition.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForCoreDefinition

      @Stability(Stable) @NotNull public static String arnForCoreDefinition(@NotNull ICoreDefinitionRef resource)
      Parameters:
      resource - This parameter is required.

    • fromCoreDefinitionArn

      @Stability(Stable) @NotNull public static ICoreDefinitionRef fromCoreDefinitionArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new ICoreDefinitionRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromCoreDefinitionId

      @Stability(Stable) @NotNull public static ICoreDefinitionRef fromCoreDefinitionId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String coreDefinitionId)
      Creates a new ICoreDefinitionRef from a coreDefinitionId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      coreDefinitionId - This parameter is required.

    • isCfnCoreDefinition

      @Stability(Stable) @NotNull public static Boolean isCfnCoreDefinition(@NotNull Object x)
      Checks whether the given object is a CfnCoreDefinition.

      Parameters:
      x - This parameter is required.

    • 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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the CoreDefinition , such as arn:aws:greengrass:us-east-1: :/greengrass/definition/cores/1234a5b6-78cd-901e-2fgh-3i45j6k178l9 .

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the CoreDefinition , such as 1234a5b6-78cd-901e-2fgh-3i45j6k178l9 .

    • getAttrLatestVersionArn

      @Stability(Stable) @NotNull public String getAttrLatestVersionArn()
      The ARN of the last CoreDefinitionVersion that was added to the CoreDefinition , such as arn:aws:greengrass:us-east-1: :/greengrass/definition/cores/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2 .

    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      The name of the CoreDefinition , such as MyCoreDefinition .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCoreDefinitionRef

      @Stability(Stable) @NotNull public CoreDefinitionReference getCoreDefinitionRef()
      A reference to a CoreDefinition resource.
      Specified by:
      getCoreDefinitionRef in interface ICoreDefinitionRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the core definition.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the core definition.

    • getInitialVersion

      @Stability(Stable) @Nullable public Object getInitialVersion()
      The core definition version to include when the core definition is created.

      Returns union: either IResolvable or CfnCoreDefinition.CoreDefinitionVersionProperty

    • setInitialVersion

      @Stability(Stable) public void setInitialVersion(@Nullable IResolvable value)
      The core definition version to include when the core definition is created.

    • setInitialVersion

      @Stability(Stable) public void setInitialVersion(@Nullable CfnCoreDefinition.CoreDefinitionVersionProperty value)
      The core definition version to include when the core definition is created.

    • getTagsRaw

      @Stability(Stable) @Nullable public Object getTagsRaw()
      Application-specific metadata to attach to the core definition.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Object value)
      Application-specific metadata to attach to the core definition.