Package software.amazon.awscdk.services.greengrass

Interface CfnResourceDefinition.ResourceInstanceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnResourceDefinition.ResourceInstanceProperty.Jsii$Proxy

Enclosing class:

CfnResourceDefinition

@Stability(Stable)
public static interface CfnResourceDefinition.ResourceInstanceProperty
extends software.amazon.jsii.JsiiSerializable

A local resource, machine learning resource, or secret resource.

For more information, see Access Local Resources with Lambda Functions , Perform Machine Learning Inference , and Deploy Secrets to the AWS IoT Greengrass Core in the Developer Guide .

In an AWS CloudFormation template, the Resources property of the AWS::Greengrass::ResourceDefinition resource contains a list of ResourceInstance property types.

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.*;
 ResourceInstanceProperty resourceInstanceProperty = 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnResourceDefinition.ResourceInstanceProperty.Builder	A builder for CfnResourceDefinition.ResourceInstanceProperty
static final class	CfnResourceDefinition.ResourceInstanceProperty.Jsii$Proxy	An implementation for CfnResourceDefinition.ResourceInstanceProperty

Method Summary

Modifier and Type	Method	Description
static CfnResourceDefinition.ResourceInstanceProperty.Builder	builder()
String	getId()	A descriptive or arbitrary ID for the resource.
String	getName()	The descriptive resource name, which is displayed on the AWS IoT Greengrass console.
Object	getResourceDataContainer()	A container for resource data.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getId

@Stability(Stable)
@NotNull
String getId()

A descriptive or arbitrary ID for the resource.

This value must be unique within the resource definition version. Maximum length is 128 characters with pattern [a-zA-Z0-9:_-]+ .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html#cfn-greengrass-resourcedefinition-resourceinstance-id

getName

@Stability(Stable)
@NotNull
String getName()

The descriptive resource name, which is displayed on the AWS IoT Greengrass console.

Maximum length 128 characters with pattern [a-zA-Z0-9:_-]+. This must be unique within a Greengrass group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html#cfn-greengrass-resourcedefinition-resourceinstance-name

getResourceDataContainer

@Stability(Stable)
@NotNull
Object getResourceDataContainer()

A container for resource data.

The container takes only one of the following supported resource data types: LocalDeviceResourceData , LocalVolumeResourceData , SageMakerMachineLearningModelResourceData , S3MachineLearningModelResourceData , or SecretsManagerSecretResourceData .

Only one resource type can be defined for a ResourceDataContainer instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html#cfn-greengrass-resourcedefinition-resourceinstance-resourcedatacontainer

builder

@Stability(Stable)
static CfnResourceDefinition.ResourceInstanceProperty.Builder builder()

Returns:

a CfnResourceDefinition.ResourceInstanceProperty.Builder of CfnResourceDefinition.ResourceInstanceProperty