CfnResourceDefinition

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.greengrass.CfnResourceDefinition

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:46.625Z")
public class CfnResourceDefinition
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Greengrass::ResourceDefinition`.

The AWS::Greengrass::ResourceDefinition resource represents a resource definition for AWS IoT Greengrass . Resource definitions are used to organize your resource definition versions.

Resource definitions can reference multiple resource definition versions. All resource definition versions must be associated with a resource definition. Each resource definition version can contain one or more resources. (In AWS CloudFormation , resources are named resource instances .)

When you create a resource definition, you can optionally include an initial resource definition version. To associate a resource definition version later, create an AWS::Greengrass::ResourceDefinitionVersion resource and specify the ID of this resource definition.
After you create the resource definition version that contains the resources 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;
 CfnResourceDefinition cfnResourceDefinition = CfnResourceDefinition.Builder.create(this, "MyCfnResourceDefinition")
         .name("name")
         // the properties below are optional
         .initialVersion(ResourceDefinitionVersionProperty.builder()
                 .resources(List.of(ResourceInstanceProperty.builder()
                         .id("id")
                         .name("name")
                         .resourceDataContainer(ResourceDataContainerProperty.builder()
                                 .localDeviceResourceData(LocalDeviceResourceDataProperty.builder()
                                         .sourcePath("sourcePath")
                                         // the properties below are optional
                                         .groupOwnerSetting(GroupOwnerSettingProperty.builder()
                                                 .autoAddGroupOwner(false)
                                                 // the properties below are optional
                                                 .groupOwner("groupOwner")
                                                 .build())
                                         .build())
                                 .localVolumeResourceData(LocalVolumeResourceDataProperty.builder()
                                         .destinationPath("destinationPath")
                                         .sourcePath("sourcePath")
                                         // the properties below are optional
                                         .groupOwnerSetting(GroupOwnerSettingProperty.builder()
                                                 .autoAddGroupOwner(false)
                                                 // the properties below are optional
                                                 .groupOwner("groupOwner")
                                                 .build())
                                         .build())
                                 .s3MachineLearningModelResourceData(S3MachineLearningModelResourceDataProperty.builder()
                                         .destinationPath("destinationPath")
                                         .s3Uri("s3Uri")
                                         // the properties below are optional
                                         .ownerSetting(ResourceDownloadOwnerSettingProperty.builder()
                                                 .groupOwner("groupOwner")
                                                 .groupPermission("groupPermission")
                                                 .build())
                                         .build())
                                 .sageMakerMachineLearningModelResourceData(SageMakerMachineLearningModelResourceDataProperty.builder()
                                         .destinationPath("destinationPath")
                                         .sageMakerJobArn("sageMakerJobArn")
                                         // the properties below are optional
                                         .ownerSetting(ResourceDownloadOwnerSettingProperty.builder()
                                                 .groupOwner("groupOwner")
                                                 .groupPermission("groupPermission")
                                                 .build())
                                         .build())
                                 .secretsManagerSecretResourceData(SecretsManagerSecretResourceDataProperty.builder()
                                         .arn("arn")
                                         // the properties below are optional
                                         .additionalStagingLabelsToDownload(List.of("additionalStagingLabelsToDownload"))
                                         .build())
                                 .build())
                         .build()))
                 .build())
         .tags(tags)
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnResourceDefinition.Builder` A fluent builder for `CfnResourceDefinition`.
`static interface`	`CfnResourceDefinition.GroupOwnerSettingProperty` Settings that define additional Linux OS group permissions to give to the Lambda function process.
`static interface`	`CfnResourceDefinition.LocalDeviceResourceDataProperty` Settings for a local device resource, which represents a file under `/dev` .
`static interface`	`CfnResourceDefinition.LocalVolumeResourceDataProperty` Settings for a local volume resource, which represents a file or directory on the root file system.
`static interface`	`CfnResourceDefinition.ResourceDataContainerProperty` A container for resource data, which defines the resource type.
`static interface`	`CfnResourceDefinition.ResourceDefinitionVersionProperty` A resource definition version contains a list of resources.
`static interface`	`CfnResourceDefinition.ResourceDownloadOwnerSettingProperty` The owner setting for a downloaded machine learning resource.
`static interface`	`CfnResourceDefinition.ResourceInstanceProperty` A local resource, machine learning resource, or secret resource.
`static interface`	`CfnResourceDefinition.S3MachineLearningModelResourceDataProperty` Settings for an Amazon S3 machine learning resource.
`static interface`	`CfnResourceDefinition.SageMakerMachineLearningModelResourceDataProperty` Settings for an Secrets Manager machine learning resource.
`static interface`	`CfnResourceDefinition.SecretsManagerSecretResourceDataProperty` Settings for a secret resource, which references a secret from AWS Secrets Manager .

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnResourceDefinition(Construct scope, java.lang.String id, CfnResourceDefinitionProps props)` Create a new `AWS::Greengrass::ResourceDefinition`.
`protected`	`CfnResourceDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnResourceDefinition(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrArn()` The Amazon Resource Name (ARN) of the `ResourceDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/resources/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
`java.lang.String`	`getAttrId()` The ID of the `ResourceDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
`java.lang.String`	`getAttrLatestVersionArn()` The ARN of the last `ResourceDefinitionVersion` that was added to the `ResourceDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/resources/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2` .
`java.lang.String`	`getAttrName()` The name of the `ResourceDefinition` , such as `MyResourceDefinition` .
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getInitialVersion()` The resource definition version to include when the resource definition is created.
`java.lang.String`	`getName()` The name of the resource definition.
`TagManager`	`getTags()` Application-specific metadata to attach to the resource definition.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setInitialVersion(CfnResourceDefinition.ResourceDefinitionVersionProperty value)` The resource definition version to include when the resource definition is created.
`void`	`setInitialVersion(IResolvable value)` The resource definition version to include when the resource definition is created.
`void`	`setName(java.lang.String value)` The name of the resource definition.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnResourceDefinition
```
protected CfnResourceDefinition(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnResourceDefinition
```
protected CfnResourceDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnResourceDefinition
```
public CfnResourceDefinition(Construct scope,
                             java.lang.String id,
                             CfnResourceDefinitionProps props)
```
    Create a new `AWS::Greengrass::ResourceDefinition`.
    
    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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The Amazon Resource Name (ARN) of the `ResourceDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/resources/1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
  - getAttrId
```
public java.lang.String getAttrId()
```
    The ID of the `ResourceDefinition` , such as `1234a5b6-78cd-901e-2fgh-3i45j6k178l9` .
  - getAttrLatestVersionArn
```
public java.lang.String getAttrLatestVersionArn()
```
    The ARN of the last `ResourceDefinitionVersion` that was added to the `ResourceDefinition` , such as `arn:aws:greengrass:us-east-1: :/greengrass/definition/resources/1234a5b6-78cd-901e-2fgh-3i45j6k178l9/versions/9876ac30-4bdb-4f9d-95af-b5fdb66be1a2` .
  - getAttrName
```
public java.lang.String getAttrName()
```
    The name of the `ResourceDefinition` , such as `MyResourceDefinition` .
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    Application-specific metadata to attach to the resource 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
```
public java.lang.String getName()
```
    The name of the resource definition.
  - setName
```
public void setName(java.lang.String value)
```
    The name of the resource definition.
  - getInitialVersion
```
public java.lang.Object getInitialVersion()
```
    The resource definition version to include when the resource definition is created.
    A resource definition version contains a list of resource instance property types.
    
    To associate a resource definition version after the resource definition is created, create an AWS::Greengrass::ResourceDefinitionVersion resource and specify the ID of this resource definition.
  - setInitialVersion
```
public void setInitialVersion(IResolvable value)
```
    The resource definition version to include when the resource definition is created.
    A resource definition version contains a list of resource instance property types.
    
    To associate a resource definition version after the resource definition is created, create an AWS::Greengrass::ResourceDefinitionVersion resource and specify the ID of this resource definition.
  - setInitialVersion
```
public void setInitialVersion(CfnResourceDefinition.ResourceDefinitionVersionProperty value)
```
    The resource definition version to include when the resource definition is created.
    A resource definition version contains a list of resource instance property types.
    
    To associate a resource definition version after the resource definition is created, create an AWS::Greengrass::ResourceDefinitionVersion resource and specify the ID of this resource definition.

Class CfnResourceDefinition

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnResourceDefinition

CfnResourceDefinition

CfnResourceDefinition

Method Detail

inspect

renderProperties

getAttrArn

getAttrId

getAttrLatestVersionArn

getAttrName

getCfnProperties

getTags

getName

setName

getInitialVersion

setInitialVersion

setInitialVersion