software.amazon.awscdk.services.greengrass

Interface CfnCoreDefinition.CoreProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCoreDefinition.CoreProperty.Jsii$Proxy

Enclosing class:

CfnCoreDefinition

@Stability(value=Stable)
public static interface CfnCoreDefinition.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 CoreDefinitionVersion property type 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnCoreDefinition.CoreProperty.Builder	builder()
String	getCertificateArn() The Amazon Resource Name (ARN) of the device certificate for the core.
String	getId() A descriptive or arbitrary ID for the core.
default Object	getSyncShadow() Indicates whether the core's local shadow is synced with the cloud automatically.
String	getThingArn() The ARN of the core, which is an AWS IoT device (thing).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCertificateArn

@Stability(value=Stable)
 @NotNull
String getCertificateArn()

The Amazon Resource Name (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(value=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(value=Stable)
 @NotNull
String getThingArn()

The ARN of the core, which is an AWS IoT device (thing).

getSyncShadow

@Stability(value=Stable)
 @Nullable
default Object getSyncShadow()

Indicates whether the core's local shadow is synced with the cloud automatically.

The default is false.

builder

@Stability(value=Stable)
static CfnCoreDefinition.CoreProperty.Builder builder()

Returns:

a CfnCoreDefinition.CoreProperty.Builder of CfnCoreDefinition.CoreProperty