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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.600Z")
 @Stability(value=Stable)
public class CfnCoreDefinition
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Greengrass::CoreDefinition`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCoreDefinition.Builder A fluent builder for CfnCoreDefinition.
static interface	CfnCoreDefinition.CoreDefinitionVersionProperty A core definition version contains a Greengrass [core](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-coredefinition-core.html) .
static interface	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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCoreDefinition(software.constructs.Construct scope, String id, CfnCoreDefinitionProps props) Create a new `AWS::Greengrass::CoreDefinition`.
protected	CfnCoreDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCoreDefinition(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
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` .
String	getAttrId() The ID of the `CoreDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
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` .
String	getAttrName() The name of the `CoreDefinition` , such as `MyCoreDefinition` .
protected Map<String,Object>	getCfnProperties()
Object	getInitialVersion() The core definition version to include when the core definition is created.
String	getName() The name of the core definition.
TagManager	getTags() Application-specific metadata to attach to the core definition.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setInitialVersion(CfnCoreDefinition.CoreDefinitionVersionProperty value) The core definition version to include when the core definition is created.
void	setInitialVersion(IResolvable value) The core definition version to include when the core definition is created.
void	setName(String value) The name of the core definition.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCoreDefinition

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

CfnCoreDefinition

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

CfnCoreDefinition

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=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(value=Stable)
 @NotNull
public String getAttrId()

The ID of the `CoreDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .

getAttrLatestVersionArn

@Stability(value=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(value=Stable)
 @NotNull
public String getAttrName()

The name of the `CoreDefinition` , such as `MyCoreDefinition` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Application-specific metadata to attach to the core definition.

You can use tags in IAM policies to control access to AWS IoT Greengrass resources. You can also use tags to categorize your resources. For more information, see Tagging Your AWS IoT Greengrass Resources in the Developer Guide .

This Json property type is processed as a map of key-value pairs. It uses the following format, which is different from most Tags implementations in AWS CloudFormation templates.

 "Tags": { "KeyName0": "value", "KeyName1": "value", "KeyName2": "value"
 }
 

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The name of the core definition.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The name of the core definition.

getInitialVersion

@Stability(value=Stable)
 @Nullable
public Object getInitialVersion()

The core definition version to include when the core definition is created.

Currently, a core definition version can contain only one core .

To associate a core definition version after the core definition is created, create an AWS::Greengrass::CoreDefinitionVersion resource and specify the ID of this core definition.

setInitialVersion

@Stability(value=Stable)
public void setInitialVersion(@Nullable
                                                       CfnCoreDefinition.CoreDefinitionVersionProperty value)

The core definition version to include when the core definition is created.

Currently, a core definition version can contain only one core .

To associate a core definition version after the core definition is created, create an AWS::Greengrass::CoreDefinitionVersion resource and specify the ID of this core definition.

setInitialVersion

@Stability(value=Stable)
public void setInitialVersion(@Nullable
                                                       IResolvable value)

The core definition version to include when the core definition is created.

Currently, a core definition version can contain only one core .

To associate a core definition version after the core definition is created, create an AWS::Greengrass::CoreDefinitionVersion resource and specify the ID of this core definition.