1.204.0

interface CoreProperty

LanguageType name
.NETAmazon.CDK.AWS.Greengrass.CfnCoreDefinition.CoreProperty
Javasoftware.amazon.awscdk.services.greengrass.CfnCoreDefinition.CoreProperty
Pythonaws_cdk.aws_greengrass.CfnCoreDefinition.CoreProperty
TypeScript @aws-cdk/aws-greengrass » CfnCoreDefinition » CoreProperty

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 * as greengrass from '@aws-cdk/aws-greengrass';
const coreProperty: greengrass.CfnCoreDefinition.CoreProperty = {
  certificateArn: 'certificateArn',
  id: 'id',
  thingArn: 'thingArn',

  // the properties below are optional
  syncShadow: false,
};

Properties

NameTypeDescription
certificateArnstringThe Amazon Resource Name (ARN) of the device certificate for the core.
idstringA descriptive or arbitrary ID for the core.
thingArnstringThe ARN of the core, which is an AWS IoT device (thing).
syncShadow?boolean | IResolvableIndicates whether the core's local shadow is synced with the cloud automatically.

certificateArn

Type: string

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.

id

Type: string

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:_-]+ .

thingArn

Type: string

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

syncShadow?

Type: boolean | IResolvable (optional)

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

The default is false.

← PreviousNext →