CfnResourceDefinitionVersionPropsMixin

class aws_cdk.mixins_preview.aws_greengrass.mixins.CfnResourceDefinitionVersionPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::Greengrass::ResourceDefinitionVersion resource represents a resource definition version for AWS IoT Greengrass .

A resource definition version contains a list of resources. (In CloudFormation , resources are named resource instances .) .. epigraph:

To create a resource definition version, you must specify the ID of the resource definition that you want to associate with the version. For information about creating a resource definition, see ```AWS::Greengrass::ResourceDefinition`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html>`_ .

After you create a 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`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html>`_ .
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html

CloudformationResource:

AWS::Greengrass::ResourceDefinitionVersion

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_greengrass import mixins as greengrass_mixins

cfn_resource_definition_version_props_mixin = greengrass_mixins.CfnResourceDefinitionVersionPropsMixin(greengrass_mixins.CfnResourceDefinitionVersionMixinProps(
    resource_definition_id="resourceDefinitionId",
    resources=[greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.ResourceInstanceProperty(
        id="id",
        name="name",
        resource_data_container=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.ResourceDataContainerProperty(
            local_device_resource_data=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.LocalDeviceResourceDataProperty(
                group_owner_setting=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.GroupOwnerSettingProperty(
                    auto_add_group_owner=False,
                    group_owner="groupOwner"
                ),
                source_path="sourcePath"
            ),
            local_volume_resource_data=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.LocalVolumeResourceDataProperty(
                destination_path="destinationPath",
                group_owner_setting=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.GroupOwnerSettingProperty(
                    auto_add_group_owner=False,
                    group_owner="groupOwner"
                ),
                source_path="sourcePath"
            ),
            s3_machine_learning_model_resource_data=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.S3MachineLearningModelResourceDataProperty(
                destination_path="destinationPath",
                owner_setting=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.ResourceDownloadOwnerSettingProperty(
                    group_owner="groupOwner",
                    group_permission="groupPermission"
                ),
                s3_uri="s3Uri"
            ),
            sage_maker_machine_learning_model_resource_data=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.SageMakerMachineLearningModelResourceDataProperty(
                destination_path="destinationPath",
                owner_setting=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.ResourceDownloadOwnerSettingProperty(
                    group_owner="groupOwner",
                    group_permission="groupPermission"
                ),
                sage_maker_job_arn="sageMakerJobArn"
            ),
            secrets_manager_secret_resource_data=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.SecretsManagerSecretResourceDataProperty(
                additional_staging_labels_to_download=["additionalStagingLabelsToDownload"],
                arn="arn"
            )
        )
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Greengrass::ResourceDefinitionVersion.

Parameters:

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['resourceDefinitionId', 'resources']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

GroupOwnerSettingProperty

class CfnResourceDefinitionVersionPropsMixin.GroupOwnerSettingProperty(*, auto_add_group_owner=None, group_owner=None)

Bases: object

Settings that define additional Linux OS group permissions to give to the Lambda function process.

You can give the permissions of the Linux group that owns the resource or choose another Linux group. These permissions are in addition to the function’s RunAs permissions.

In an CloudFormation template, GroupOwnerSetting is a property of the `LocalDeviceResourceData <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localdeviceresourcedata.html>`_ and `LocalVolumeResourceData <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html>`_ property types.

Parameters:

  • auto_add_group_owner (Union[bool, IResolvable, None]) – Indicates whether to give the privileges of the Linux group that owns the resource to the Lambda process. This gives the Lambda process the file access permissions of the Linux group.

  • group_owner (Optional[str]) – The name of the Linux group whose privileges you want to add to the Lambda process. This value is ignored if AutoAddGroupOwner is true.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-groupownersetting.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_greengrass import mixins as greengrass_mixins

group_owner_setting_property = greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.GroupOwnerSettingProperty(
    auto_add_group_owner=False,
    group_owner="groupOwner"
)

Attributes

auto_add_group_owner

Indicates whether to give the privileges of the Linux group that owns the resource to the Lambda process.

This gives the Lambda process the file access permissions of the Linux group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-groupownersetting.html#cfn-greengrass-resourcedefinitionversion-groupownersetting-autoaddgroupowner

group_owner

The name of the Linux group whose privileges you want to add to the Lambda process.

This value is ignored if AutoAddGroupOwner is true.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-groupownersetting.html#cfn-greengrass-resourcedefinitionversion-groupownersetting-groupowner

LocalDeviceResourceDataProperty

class CfnResourceDefinitionVersionPropsMixin.LocalDeviceResourceDataProperty(*, group_owner_setting=None, source_path=None)

Bases: object

Settings for a local device resource, which represents a file under /dev .

For more information, see Access Local Resources with Lambda Functions in the Developer Guide .

In an CloudFormation template, LocalDeviceResourceData can be used in the `ResourceDataContainer <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html>`_ property type.

Parameters:

  • group_owner_setting (Union[IResolvable, GroupOwnerSettingProperty, Dict[str, Any], None]) – Settings that define additional Linux OS group permissions to give to the Lambda function process.

  • source_path (Optional[str]) – The local absolute path of the device resource. The source path for a device resource can refer only to a character device or block device under /dev .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localdeviceresourcedata.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_greengrass import mixins as greengrass_mixins

local_device_resource_data_property = greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.LocalDeviceResourceDataProperty(
    group_owner_setting=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.GroupOwnerSettingProperty(
        auto_add_group_owner=False,
        group_owner="groupOwner"
    ),
    source_path="sourcePath"
)

Attributes

group_owner_setting

Settings that define additional Linux OS group permissions to give to the Lambda function process.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localdeviceresourcedata.html#cfn-greengrass-resourcedefinitionversion-localdeviceresourcedata-groupownersetting

source_path

The local absolute path of the device resource.

The source path for a device resource can refer only to a character device or block device under /dev .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localdeviceresourcedata.html#cfn-greengrass-resourcedefinitionversion-localdeviceresourcedata-sourcepath

LocalVolumeResourceDataProperty

class CfnResourceDefinitionVersionPropsMixin.LocalVolumeResourceDataProperty(*, destination_path=None, group_owner_setting=None, source_path=None)

Bases: object

Settings for a local volume resource, which represents a file or directory on the root file system.

For more information, see Access Local Resources with Lambda Functions in the Developer Guide .

In an CloudFormation template, LocalVolumeResourceData can be used in the `ResourceDataContainer <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html>`_ property type.

Parameters:

  • destination_path (Optional[str]) – The absolute local path of the resource in the Lambda environment.

  • group_owner_setting (Union[IResolvable, GroupOwnerSettingProperty, Dict[str, Any], None]) – Settings that define additional Linux OS group permissions to give to the Lambda function process.

  • source_path (Optional[str]) – The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with /sys .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_greengrass import mixins as greengrass_mixins

local_volume_resource_data_property = greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.LocalVolumeResourceDataProperty(
    destination_path="destinationPath",
    group_owner_setting=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.GroupOwnerSettingProperty(
        auto_add_group_owner=False,
        group_owner="groupOwner"
    ),
    source_path="sourcePath"
)

Attributes

destination_path

The absolute local path of the resource in the Lambda environment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html#cfn-greengrass-resourcedefinitionversion-localvolumeresourcedata-destinationpath

group_owner_setting

Settings that define additional Linux OS group permissions to give to the Lambda function process.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html#cfn-greengrass-resourcedefinitionversion-localvolumeresourcedata-groupownersetting

source_path

The local absolute path of the volume resource on the host.

The source path for a volume resource type cannot start with /sys .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-localvolumeresourcedata.html#cfn-greengrass-resourcedefinitionversion-localvolumeresourcedata-sourcepath

ResourceDataContainerProperty

class CfnResourceDefinitionVersionPropsMixin.ResourceDataContainerProperty(*, local_device_resource_data=None, local_volume_resource_data=None, s3_machine_learning_model_resource_data=None, sage_maker_machine_learning_model_resource_data=None, secrets_manager_secret_resource_data=None)

Bases: object

A container for resource data, which defines the resource type.

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

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

In an CloudFormation template, ResourceDataContainer is a property of the `ResourceInstance <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html>`_ property type.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_greengrass import mixins as greengrass_mixins

resource_data_container_property = greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.ResourceDataContainerProperty(
    local_device_resource_data=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.LocalDeviceResourceDataProperty(
        group_owner_setting=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.GroupOwnerSettingProperty(
            auto_add_group_owner=False,
            group_owner="groupOwner"
        ),
        source_path="sourcePath"
    ),
    local_volume_resource_data=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.LocalVolumeResourceDataProperty(
        destination_path="destinationPath",
        group_owner_setting=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.GroupOwnerSettingProperty(
            auto_add_group_owner=False,
            group_owner="groupOwner"
        ),
        source_path="sourcePath"
    ),
    s3_machine_learning_model_resource_data=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.S3MachineLearningModelResourceDataProperty(
        destination_path="destinationPath",
        owner_setting=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.ResourceDownloadOwnerSettingProperty(
            group_owner="groupOwner",
            group_permission="groupPermission"
        ),
        s3_uri="s3Uri"
    ),
    sage_maker_machine_learning_model_resource_data=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.SageMakerMachineLearningModelResourceDataProperty(
        destination_path="destinationPath",
        owner_setting=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.ResourceDownloadOwnerSettingProperty(
            group_owner="groupOwner",
            group_permission="groupPermission"
        ),
        sage_maker_job_arn="sageMakerJobArn"
    ),
    secrets_manager_secret_resource_data=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.SecretsManagerSecretResourceDataProperty(
        additional_staging_labels_to_download=["additionalStagingLabelsToDownload"],
        arn="arn"
    )
)

Attributes

local_device_resource_data

Settings for a local device resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-localdeviceresourcedata

local_volume_resource_data

Settings for a local volume resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-localvolumeresourcedata

s3_machine_learning_model_resource_data

Settings for a machine learning resource stored in Amazon S3 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-s3machinelearningmodelresourcedata

sage_maker_machine_learning_model_resource_data

Settings for a machine learning resource saved as an SageMaker AI training job.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-sagemakermachinelearningmodelresourcedata

secrets_manager_secret_resource_data

Settings for a secret resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html#cfn-greengrass-resourcedefinitionversion-resourcedatacontainer-secretsmanagersecretresourcedata

ResourceDownloadOwnerSettingProperty

class CfnResourceDefinitionVersionPropsMixin.ResourceDownloadOwnerSettingProperty(*, group_owner=None, group_permission=None)

Bases: object

The owner setting for a downloaded machine learning resource.

For more information, see Access Machine Learning Resources from Lambda Functions in the Developer Guide .

In an CloudFormation template, ResourceDownloadOwnerSetting is the property type of the OwnerSetting property for the `S3MachineLearningModelResourceData <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html>`_ and `SageMakerMachineLearningModelResourceData <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html>`_ property types.

Parameters:

  • group_owner (Optional[str]) – The group owner of the machine learning resource. This is the group ID (GID) of an existing Linux OS group on the system. The group’s permissions are added to the Lambda process.

  • group_permission (Optional[str]) – The permissions that the group owner has to the machine learning resource. Valid values are rw (read-write) or ro (read-only).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedownloadownersetting.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_greengrass import mixins as greengrass_mixins

resource_download_owner_setting_property = greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.ResourceDownloadOwnerSettingProperty(
    group_owner="groupOwner",
    group_permission="groupPermission"
)

Attributes

group_owner

The group owner of the machine learning resource.

This is the group ID (GID) of an existing Linux OS group on the system. The group’s permissions are added to the Lambda process.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedownloadownersetting.html#cfn-greengrass-resourcedefinitionversion-resourcedownloadownersetting-groupowner

group_permission

The permissions that the group owner has to the machine learning resource.

Valid values are rw (read-write) or ro (read-only).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedownloadownersetting.html#cfn-greengrass-resourcedefinitionversion-resourcedownloadownersetting-grouppermission

ResourceInstanceProperty

class CfnResourceDefinitionVersionPropsMixin.ResourceInstanceProperty(*, id=None, name=None, resource_data_container=None)

Bases: object

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 CloudFormation template, the Resources property of the `AWS::Greengrass::ResourceDefinitionVersion <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html>`_ resource contains a list of ResourceInstance property types.

Parameters:

  • id (Optional[str]) – 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:_-]+ .

  • name (Optional[str]) – 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.

  • resource_data_container (Union[IResolvable, ResourceDataContainerProperty, Dict[str, Any], None]) – A container for resource data. The container takes only one of the following supported resource data types: LocalDeviceResourceData , LocalVolumeResourceData , SageMakerMachineLearningModelResourceData , S3MachineLearningModelResourceData , or SecretsManagerSecretResourceData . .. epigraph:: Only one resource type can be defined for a ResourceDataContainer instance.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_greengrass import mixins as greengrass_mixins

resource_instance_property = greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.ResourceInstanceProperty(
    id="id",
    name="name",
    resource_data_container=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.ResourceDataContainerProperty(
        local_device_resource_data=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.LocalDeviceResourceDataProperty(
            group_owner_setting=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.GroupOwnerSettingProperty(
                auto_add_group_owner=False,
                group_owner="groupOwner"
            ),
            source_path="sourcePath"
        ),
        local_volume_resource_data=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.LocalVolumeResourceDataProperty(
            destination_path="destinationPath",
            group_owner_setting=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.GroupOwnerSettingProperty(
                auto_add_group_owner=False,
                group_owner="groupOwner"
            ),
            source_path="sourcePath"
        ),
        s3_machine_learning_model_resource_data=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.S3MachineLearningModelResourceDataProperty(
            destination_path="destinationPath",
            owner_setting=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.ResourceDownloadOwnerSettingProperty(
                group_owner="groupOwner",
                group_permission="groupPermission"
            ),
            s3_uri="s3Uri"
        ),
        sage_maker_machine_learning_model_resource_data=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.SageMakerMachineLearningModelResourceDataProperty(
            destination_path="destinationPath",
            owner_setting=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.ResourceDownloadOwnerSettingProperty(
                group_owner="groupOwner",
                group_permission="groupPermission"
            ),
            sage_maker_job_arn="sageMakerJobArn"
        ),
        secrets_manager_secret_resource_data=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.SecretsManagerSecretResourceDataProperty(
            additional_staging_labels_to_download=["additionalStagingLabelsToDownload"],
            arn="arn"
        )
    )
)

Attributes

id

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:

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

name

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:

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

resource_data_container

A container for resource data.

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

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

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

S3MachineLearningModelResourceDataProperty

class CfnResourceDefinitionVersionPropsMixin.S3MachineLearningModelResourceDataProperty(*, destination_path=None, owner_setting=None, s3_uri=None)

Bases: object

Settings for an Amazon S3 machine learning resource.

For more information, see Perform Machine Learning Inference in the Developer Guide .

In an CloudFormation template, S3MachineLearningModelResourceData can be used in the `ResourceDataContainer <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html>`_ property type.

Parameters:

  • destination_path (Optional[str]) – The absolute local path of the resource inside the Lambda environment.

  • owner_setting (Union[IResolvable, ResourceDownloadOwnerSettingProperty, Dict[str, Any], None]) –

    The owner setting for the downloaded machine learning resource. For more information, see Access Machine Learning Resources from Lambda Functions in the Developer Guide .

  • s3_uri (Optional[str]) – The URI of the source model in an Amazon S3 bucket. The model package must be in tar.gz or .zip format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_greengrass import mixins as greengrass_mixins

s3_machine_learning_model_resource_data_property = greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.S3MachineLearningModelResourceDataProperty(
    destination_path="destinationPath",
    owner_setting=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.ResourceDownloadOwnerSettingProperty(
        group_owner="groupOwner",
        group_permission="groupPermission"
    ),
    s3_uri="s3Uri"
)

Attributes

destination_path

The absolute local path of the resource inside the Lambda environment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata-destinationpath

owner_setting

The owner setting for the downloaded machine learning resource.

For more information, see Access Machine Learning Resources from Lambda Functions in the Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata-ownersetting

s3_uri

The URI of the source model in an Amazon S3 bucket.

The model package must be in tar.gz or .zip format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-s3machinelearningmodelresourcedata-s3uri

SageMakerMachineLearningModelResourceDataProperty

class CfnResourceDefinitionVersionPropsMixin.SageMakerMachineLearningModelResourceDataProperty(*, destination_path=None, owner_setting=None, sage_maker_job_arn=None)

Bases: object

Settings for an Secrets Manager machine learning resource.

For more information, see Perform Machine Learning Inference in the Developer Guide .

In an CloudFormation template, SageMakerMachineLearningModelResourceData can be used in the `ResourceDataContainer <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html>`_ property type.

Parameters:

  • destination_path (Optional[str]) – The absolute local path of the resource inside the Lambda environment.

  • owner_setting (Union[IResolvable, ResourceDownloadOwnerSettingProperty, Dict[str, Any], None]) –

    The owner setting for the downloaded machine learning resource. For more information, see Access Machine Learning Resources from Lambda Functions in the Developer Guide .

  • sage_maker_job_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon SageMaker AI training job that represents the source model.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_greengrass import mixins as greengrass_mixins

sage_maker_machine_learning_model_resource_data_property = greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.SageMakerMachineLearningModelResourceDataProperty(
    destination_path="destinationPath",
    owner_setting=greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.ResourceDownloadOwnerSettingProperty(
        group_owner="groupOwner",
        group_permission="groupPermission"
    ),
    sage_maker_job_arn="sageMakerJobArn"
)

Attributes

destination_path

The absolute local path of the resource inside the Lambda environment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata-destinationpath

owner_setting

The owner setting for the downloaded machine learning resource.

For more information, see Access Machine Learning Resources from Lambda Functions in the Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata-ownersetting

sage_maker_job_arn

The Amazon Resource Name (ARN) of the Amazon SageMaker AI training job that represents the source model.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata.html#cfn-greengrass-resourcedefinitionversion-sagemakermachinelearningmodelresourcedata-sagemakerjobarn

SecretsManagerSecretResourceDataProperty

class CfnResourceDefinitionVersionPropsMixin.SecretsManagerSecretResourceDataProperty(*, additional_staging_labels_to_download=None, arn=None)

Bases: object

Settings for a secret resource, which references a secret from AWS Secrets Manager .

AWS IoT Greengrass stores a local, encrypted copy of the secret on the Greengrass core, where it can be securely accessed by connectors and Lambda functions. For more information, see Deploy Secrets to the AWS IoT Greengrass Core in the Developer Guide .

In an CloudFormation template, SecretsManagerSecretResourceData can be used in the `ResourceDataContainer <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html>`_ property type.

Parameters:

  • additional_staging_labels_to_download (Optional[Sequence[str]]) – The staging labels whose values you want to make available on the core, in addition to AWSCURRENT .

  • arn (Optional[str]) – The Amazon Resource Name (ARN) of the Secrets Manager secret to make available on the core. The value of the secret’s latest version (represented by the AWSCURRENT staging label) is included by default.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_greengrass import mixins as greengrass_mixins

secrets_manager_secret_resource_data_property = greengrass_mixins.CfnResourceDefinitionVersionPropsMixin.SecretsManagerSecretResourceDataProperty(
    additional_staging_labels_to_download=["additionalStagingLabelsToDownload"],
    arn="arn"
)

Attributes

additional_staging_labels_to_download

The staging labels whose values you want to make available on the core, in addition to AWSCURRENT .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata.html#cfn-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata-additionalstaginglabelstodownload

arn

The Amazon Resource Name (ARN) of the Secrets Manager secret to make available on the core.

The value of the secret’s latest version (represented by the AWSCURRENT staging label) is included by default.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata.html#cfn-greengrass-resourcedefinitionversion-secretsmanagersecretresourcedata-arn