software.amazon.awscdk.services.greengrass

Class CfnCoreDefinitionVersion

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

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.603Z")
 @Stability(value=Stable)
public class CfnCoreDefinitionVersion
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Greengrass::CoreDefinitionVersion`.

The AWS::Greengrass::CoreDefinitionVersion resource represents a core definition version for AWS IoT Greengrass . A core definition version contains a Greengrass core.

To create a core definition version, you must specify the ID of the core definition that you want to associate with the version. For information about creating a core definition, see AWS::Greengrass::CoreDefinition .

After you create a 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.*;
 CfnCoreDefinitionVersion cfnCoreDefinitionVersion = CfnCoreDefinitionVersion.Builder.create(this, "MyCfnCoreDefinitionVersion")
         .coreDefinitionId("coreDefinitionId")
         .cores(List.of(CoreProperty.builder()
                 .certificateArn("certificateArn")
                 .id("id")
                 .thingArn("thingArn")
                 // the properties below are optional
                 .syncShadow(false)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCoreDefinitionVersion.Builder A fluent builder for CfnCoreDefinitionVersion.
static interface	CfnCoreDefinitionVersion.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
	CfnCoreDefinitionVersion(software.constructs.Construct scope, String id, CfnCoreDefinitionVersionProps props) Create a new `AWS::Greengrass::CoreDefinitionVersion`.
protected	CfnCoreDefinitionVersion(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCoreDefinitionVersion(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getCoreDefinitionId() The ID of the core definition associated with this version.
Object	getCores() The Greengrass core in this version.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCoreDefinitionId(String value) The ID of the core definition associated with this version.
void	setCores(IResolvable value) The Greengrass core in this version.
void	setCores(List<Object> value) The Greengrass core in this version.

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

CfnCoreDefinitionVersion

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

CfnCoreDefinitionVersion

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

CfnCoreDefinitionVersion

@Stability(value=Stable)
public CfnCoreDefinitionVersion(@NotNull
                                                         software.constructs.Construct scope,
                                                         @NotNull
                                                         String id,
                                                         @NotNull
                                                         CfnCoreDefinitionVersionProps props)

Create a new `AWS::Greengrass::CoreDefinitionVersion`.

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.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getCoreDefinitionId

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

The ID of the core definition associated with this version.

This value is a GUID.

setCoreDefinitionId

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

The ID of the core definition associated with this version.

This value is a GUID.

getCores

@Stability(value=Stable)
 @NotNull
public Object getCores()

The Greengrass core in this version.

Currently, the Cores property for a core definition version can contain only one core.

setCores

@Stability(value=Stable)
public void setCores(@NotNull
                                              IResolvable value)

The Greengrass core in this version.

Currently, the Cores property for a core definition version can contain only one core.

setCores

@Stability(value=Stable)
public void setCores(@NotNull
                                              List<Object> value)

The Greengrass core in this version.

Currently, the Cores property for a core definition version can contain only one core.