Interface CfnCoreDefinitionVersion.CoreProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnCoreDefinitionVersion.CoreProperty.Jsii$Proxy
Enclosing class:
CfnCoreDefinitionVersion

@Stability(Stable) public static interface CfnCoreDefinitionVersion.CoreProperty extends software.amazon.jsii.JsiiSerializable
A core is an AWS IoT device that runs the AWS IoT Greengrass core software and manages local processes for a Greengrass group.

For more information, see What Is AWS IoT Greengrass ? in the Developer Guide .

In an AWS CloudFormation template, the Cores property of the AWS::Greengrass::CoreDefinitionVersion resource contains a list of Core property types. Currently, the list can contain only one core.

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.*;
 CoreProperty coreProperty = CoreProperty.builder()
         .certificateArn("certificateArn")
         .id("id")
         .thingArn("thingArn")
         // the properties below are optional
         .syncShadow(false)
         .build();
 
  • Method Details

    • getCertificateArn

      @Stability(Stable) @NotNull String getCertificateArn()
      The ARN of the device certificate for the core.

      This X.509 certificate is used to authenticate the core with AWS IoT and AWS IoT Greengrass services.

    • getId

      @Stability(Stable) @NotNull String getId()
      A descriptive or arbitrary ID for the core.

      This value must be unique within the core definition version. Maximum length is 128 characters with pattern [a-zA-Z0-9:_-]+ .

    • getThingArn

      @Stability(Stable) @NotNull String getThingArn()
      The Amazon Resource Name (ARN) of the core, which is an AWS IoT device (thing).
    • getSyncShadow

      @Stability(Stable) @Nullable default Object getSyncShadow()
      Indicates whether the core's local shadow is synced with the cloud automatically.

      The default is false.

    • builder

      @Stability(Stable) static CfnCoreDefinitionVersion.CoreProperty.Builder builder()
      Returns:
      a CfnCoreDefinitionVersion.CoreProperty.Builder of CfnCoreDefinitionVersion.CoreProperty