CfnResourceDefinition

class aws_cdk.aws_greengrass.CfnResourceDefinition(scope, id, *, name, initial_version=None, tags=None)

Bases: aws_cdk.core.CfnResource

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 .) .. epigraph:

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`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html>`_ 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`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-group.html>`_ .
CloudformationResource

AWS::Greengrass::ResourceDefinition

Link

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

ExampleMetadata

fixture=_generated

Example:

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

# tags: Any

cfn_resource_definition = greengrass.CfnResourceDefinition(self, "MyCfnResourceDefinition",
    name="name",

    # the properties below are optional
    initial_version=greengrass.CfnResourceDefinition.ResourceDefinitionVersionProperty(
        resources=[greengrass.CfnResourceDefinition.ResourceInstanceProperty(
            id="id",
            name="name",
            resource_data_container=greengrass.CfnResourceDefinition.ResourceDataContainerProperty(
                local_device_resource_data=greengrass.CfnResourceDefinition.LocalDeviceResourceDataProperty(
                    source_path="sourcePath",

                    # the properties below are optional
                    group_owner_setting=greengrass.CfnResourceDefinition.GroupOwnerSettingProperty(
                        auto_add_group_owner=False,

                        # the properties below are optional
                        group_owner="groupOwner"
                    )
                ),
                local_volume_resource_data=greengrass.CfnResourceDefinition.LocalVolumeResourceDataProperty(
                    destination_path="destinationPath",
                    source_path="sourcePath",

                    # the properties below are optional
                    group_owner_setting=greengrass.CfnResourceDefinition.GroupOwnerSettingProperty(
                        auto_add_group_owner=False,

                        # the properties below are optional
                        group_owner="groupOwner"
                    )
                ),
                s3_machine_learning_model_resource_data=greengrass.CfnResourceDefinition.S3MachineLearningModelResourceDataProperty(
                    destination_path="destinationPath",
                    s3_uri="s3Uri",

                    # the properties below are optional
                    owner_setting=greengrass.CfnResourceDefinition.ResourceDownloadOwnerSettingProperty(
                        group_owner="groupOwner",
                        group_permission="groupPermission"
                    )
                ),
                sage_maker_machine_learning_model_resource_data=greengrass.CfnResourceDefinition.SageMakerMachineLearningModelResourceDataProperty(
                    destination_path="destinationPath",
                    sage_maker_job_arn="sageMakerJobArn",

                    # the properties below are optional
                    owner_setting=greengrass.CfnResourceDefinition.ResourceDownloadOwnerSettingProperty(
                        group_owner="groupOwner",
                        group_permission="groupPermission"
                    )
                ),
                secrets_manager_secret_resource_data=greengrass.CfnResourceDefinition.SecretsManagerSecretResourceDataProperty(
                    arn="arn",

                    # the properties below are optional
                    additional_staging_labels_to_download=["additionalStagingLabelsToDownload"]
                )
            )
        )]
    ),
    tags=tags
)

Create a new AWS::Greengrass::ResourceDefinition.

Parameters

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Greengrass::ResourceDefinition'
attr_arn

The Amazon Resource Name (ARN) of the ResourceDefinition , such as arn:aws:greengrass:us-east-1:  :/greengrass/definition/resources/1234a5b6-78cd-901e-2fgh-3i45j6k178l9 .

CloudformationAttribute

Arn

Return type

str

attr_id

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

CloudformationAttribute

Id

Return type

str

attr_latest_version_arn

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 .

CloudformationAttribute

LatestVersionArn

Return type

str

attr_name

The name of the ResourceDefinition , such as MyResourceDefinition .

CloudformationAttribute

Name

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

initial_version

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

A resource definition version contains a list of `resource instance <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html>`_ property types. .. epigraph:

To associate a resource definition version after the resource definition is created, create an ```AWS::Greengrass::ResourceDefinitionVersion`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html>`_ resource and specify the ID of this resource definition.
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html#cfn-greengrass-resourcedefinition-initialversion

Return type

Union[IResolvable, ResourceDefinitionVersionProperty, None]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name of the resource definition.

Link

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

Return type

str

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

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"
}
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html#cfn-greengrass-resourcedefinition-tags

Return type

TagManager

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

GroupOwnerSettingProperty

class CfnResourceDefinition.GroupOwnerSettingProperty(*, auto_add_group_owner, 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 AWS CloudFormation template, GroupOwnerSetting is a property of the `LocalDeviceResourceData <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localdeviceresourcedata.html>`_ and `LocalVolumeResourceData <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-localvolumeresourcedata.html>`_ property types.

Parameters
  • auto_add_group_owner (Union[bool, IResolvable]) – 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-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.
import aws_cdk.aws_greengrass as greengrass

group_owner_setting_property = greengrass.CfnResourceDefinition.GroupOwnerSettingProperty(
    auto_add_group_owner=False,

    # the properties below are optional
    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.

Link

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

Return type

Union[bool, IResolvable]

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.

Link

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

Return type

Optional[str]

LocalDeviceResourceDataProperty

class CfnResourceDefinition.LocalDeviceResourceDataProperty(*, source_path, group_owner_setting=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 AWS CloudFormation template, LocalDeviceResourceData can be used in the `ResourceDataContainer <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html>`_ property type.

Parameters
  • source_path (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 .

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-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.
import aws_cdk.aws_greengrass as greengrass

local_device_resource_data_property = greengrass.CfnResourceDefinition.LocalDeviceResourceDataProperty(
    source_path="sourcePath",

    # the properties below are optional
    group_owner_setting=greengrass.CfnResourceDefinition.GroupOwnerSettingProperty(
        auto_add_group_owner=False,

        # the properties below are optional
        group_owner="groupOwner"
    )
)

Attributes

group_owner_setting

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

Link

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

Return type

Union[IResolvable, GroupOwnerSettingProperty, None]

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 .

Link

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

Return type

str

LocalVolumeResourceDataProperty

class CfnResourceDefinition.LocalVolumeResourceDataProperty(*, destination_path, source_path, group_owner_setting=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 AWS CloudFormation template, LocalVolumeResourceData can be used in the `ResourceDataContainer <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html>`_ property type.

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

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

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-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.
import aws_cdk.aws_greengrass as greengrass

local_volume_resource_data_property = greengrass.CfnResourceDefinition.LocalVolumeResourceDataProperty(
    destination_path="destinationPath",
    source_path="sourcePath",

    # the properties below are optional
    group_owner_setting=greengrass.CfnResourceDefinition.GroupOwnerSettingProperty(
        auto_add_group_owner=False,

        # the properties below are optional
        group_owner="groupOwner"
    )
)

Attributes

destination_path

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

Link

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

Return type

str

group_owner_setting

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

Link

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

Return type

Union[IResolvable, GroupOwnerSettingProperty, None]

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 .

Link

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

Return type

str

ResourceDataContainerProperty

class CfnResourceDefinition.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 AWS CloudFormation template, ResourceDataContainer is a property of the `ResourceInstance <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourceinstance.html>`_ property type.

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-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.
import aws_cdk.aws_greengrass as greengrass

resource_data_container_property = greengrass.CfnResourceDefinition.ResourceDataContainerProperty(
    local_device_resource_data=greengrass.CfnResourceDefinition.LocalDeviceResourceDataProperty(
        source_path="sourcePath",

        # the properties below are optional
        group_owner_setting=greengrass.CfnResourceDefinition.GroupOwnerSettingProperty(
            auto_add_group_owner=False,

            # the properties below are optional
            group_owner="groupOwner"
        )
    ),
    local_volume_resource_data=greengrass.CfnResourceDefinition.LocalVolumeResourceDataProperty(
        destination_path="destinationPath",
        source_path="sourcePath",

        # the properties below are optional
        group_owner_setting=greengrass.CfnResourceDefinition.GroupOwnerSettingProperty(
            auto_add_group_owner=False,

            # the properties below are optional
            group_owner="groupOwner"
        )
    ),
    s3_machine_learning_model_resource_data=greengrass.CfnResourceDefinition.S3MachineLearningModelResourceDataProperty(
        destination_path="destinationPath",
        s3_uri="s3Uri",

        # the properties below are optional
        owner_setting=greengrass.CfnResourceDefinition.ResourceDownloadOwnerSettingProperty(
            group_owner="groupOwner",
            group_permission="groupPermission"
        )
    ),
    sage_maker_machine_learning_model_resource_data=greengrass.CfnResourceDefinition.SageMakerMachineLearningModelResourceDataProperty(
        destination_path="destinationPath",
        sage_maker_job_arn="sageMakerJobArn",

        # the properties below are optional
        owner_setting=greengrass.CfnResourceDefinition.ResourceDownloadOwnerSettingProperty(
            group_owner="groupOwner",
            group_permission="groupPermission"
        )
    ),
    secrets_manager_secret_resource_data=greengrass.CfnResourceDefinition.SecretsManagerSecretResourceDataProperty(
        arn="arn",

        # the properties below are optional
        additional_staging_labels_to_download=["additionalStagingLabelsToDownload"]
    )
)

Attributes

local_device_resource_data

Settings for a local device resource.

Link

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

Return type

Union[IResolvable, LocalDeviceResourceDataProperty, None]

local_volume_resource_data

Settings for a local volume resource.

Link

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

Return type

Union[IResolvable, LocalVolumeResourceDataProperty, None]

s3_machine_learning_model_resource_data

Settings for a machine learning resource stored in Amazon S3 .

Link

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

Return type

Union[IResolvable, S3MachineLearningModelResourceDataProperty, None]

sage_maker_machine_learning_model_resource_data

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

Link

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

Return type

Union[IResolvable, SageMakerMachineLearningModelResourceDataProperty, None]

secrets_manager_secret_resource_data

Settings for a secret resource.

Link

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

Return type

Union[IResolvable, SecretsManagerSecretResourceDataProperty, None]

ResourceDefinitionVersionProperty

class CfnResourceDefinition.ResourceDefinitionVersionProperty(*, resources)

Bases: object

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

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>`_ .

In an AWS CloudFormation template, ResourceDefinitionVersion is the property type of the InitialVersion property in the `AWS::Greengrass::ResourceDefinition <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinition.html>`_ resource.

Parameters

resources (Union[IResolvable, Sequence[Union[IResolvable, ResourceInstanceProperty, Dict[str, Any]]]]) – The resources in this version.

Link

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

ExampleMetadata

fixture=_generated

Example:

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

resource_definition_version_property = greengrass.CfnResourceDefinition.ResourceDefinitionVersionProperty(
    resources=[greengrass.CfnResourceDefinition.ResourceInstanceProperty(
        id="id",
        name="name",
        resource_data_container=greengrass.CfnResourceDefinition.ResourceDataContainerProperty(
            local_device_resource_data=greengrass.CfnResourceDefinition.LocalDeviceResourceDataProperty(
                source_path="sourcePath",

                # the properties below are optional
                group_owner_setting=greengrass.CfnResourceDefinition.GroupOwnerSettingProperty(
                    auto_add_group_owner=False,

                    # the properties below are optional
                    group_owner="groupOwner"
                )
            ),
            local_volume_resource_data=greengrass.CfnResourceDefinition.LocalVolumeResourceDataProperty(
                destination_path="destinationPath",
                source_path="sourcePath",

                # the properties below are optional
                group_owner_setting=greengrass.CfnResourceDefinition.GroupOwnerSettingProperty(
                    auto_add_group_owner=False,

                    # the properties below are optional
                    group_owner="groupOwner"
                )
            ),
            s3_machine_learning_model_resource_data=greengrass.CfnResourceDefinition.S3MachineLearningModelResourceDataProperty(
                destination_path="destinationPath",
                s3_uri="s3Uri",

                # the properties below are optional
                owner_setting=greengrass.CfnResourceDefinition.ResourceDownloadOwnerSettingProperty(
                    group_owner="groupOwner",
                    group_permission="groupPermission"
                )
            ),
            sage_maker_machine_learning_model_resource_data=greengrass.CfnResourceDefinition.SageMakerMachineLearningModelResourceDataProperty(
                destination_path="destinationPath",
                sage_maker_job_arn="sageMakerJobArn",

                # the properties below are optional
                owner_setting=greengrass.CfnResourceDefinition.ResourceDownloadOwnerSettingProperty(
                    group_owner="groupOwner",
                    group_permission="groupPermission"
                )
            ),
            secrets_manager_secret_resource_data=greengrass.CfnResourceDefinition.SecretsManagerSecretResourceDataProperty(
                arn="arn",

                # the properties below are optional
                additional_staging_labels_to_download=["additionalStagingLabelsToDownload"]
            )
        )
    )]
)

Attributes

resources

The resources in this version.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, ResourceInstanceProperty]]]

ResourceDownloadOwnerSettingProperty

class CfnResourceDefinition.ResourceDownloadOwnerSettingProperty(*, group_owner, group_permission)

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 AWS 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-resourcedefinition-s3machinelearningmodelresourcedata.html>`_ and `SageMakerMachineLearningModelResourceData <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-sagemakermachinelearningmodelresourcedata.html>`_ property types.

Parameters
  • group_owner (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 (str) – The permissions that the group owner has to the machine learning resource. Valid values are rw (read-write) or ro (read-only).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-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.
import aws_cdk.aws_greengrass as greengrass

resource_download_owner_setting_property = greengrass.CfnResourceDefinition.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.

Link

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

Return type

str

group_permission

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

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

Link

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

Return type

str

ResourceInstanceProperty

class CfnResourceDefinition.ResourceInstanceProperty(*, id, name, resource_data_container)

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

Parameters
  • id (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 (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]]) – 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-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.
import aws_cdk.aws_greengrass as greengrass

resource_instance_property = greengrass.CfnResourceDefinition.ResourceInstanceProperty(
    id="id",
    name="name",
    resource_data_container=greengrass.CfnResourceDefinition.ResourceDataContainerProperty(
        local_device_resource_data=greengrass.CfnResourceDefinition.LocalDeviceResourceDataProperty(
            source_path="sourcePath",

            # the properties below are optional
            group_owner_setting=greengrass.CfnResourceDefinition.GroupOwnerSettingProperty(
                auto_add_group_owner=False,

                # the properties below are optional
                group_owner="groupOwner"
            )
        ),
        local_volume_resource_data=greengrass.CfnResourceDefinition.LocalVolumeResourceDataProperty(
            destination_path="destinationPath",
            source_path="sourcePath",

            # the properties below are optional
            group_owner_setting=greengrass.CfnResourceDefinition.GroupOwnerSettingProperty(
                auto_add_group_owner=False,

                # the properties below are optional
                group_owner="groupOwner"
            )
        ),
        s3_machine_learning_model_resource_data=greengrass.CfnResourceDefinition.S3MachineLearningModelResourceDataProperty(
            destination_path="destinationPath",
            s3_uri="s3Uri",

            # the properties below are optional
            owner_setting=greengrass.CfnResourceDefinition.ResourceDownloadOwnerSettingProperty(
                group_owner="groupOwner",
                group_permission="groupPermission"
            )
        ),
        sage_maker_machine_learning_model_resource_data=greengrass.CfnResourceDefinition.SageMakerMachineLearningModelResourceDataProperty(
            destination_path="destinationPath",
            sage_maker_job_arn="sageMakerJobArn",

            # the properties below are optional
            owner_setting=greengrass.CfnResourceDefinition.ResourceDownloadOwnerSettingProperty(
                group_owner="groupOwner",
                group_permission="groupPermission"
            )
        ),
        secrets_manager_secret_resource_data=greengrass.CfnResourceDefinition.SecretsManagerSecretResourceDataProperty(
            arn="arn",

            # the properties below are optional
            additional_staging_labels_to_download=["additionalStagingLabelsToDownload"]
        )
    )
)

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:_-]+ .

Link

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

Return type

str

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.

Link

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

Return type

str

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

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

Return type

Union[IResolvable, ResourceDataContainerProperty]

S3MachineLearningModelResourceDataProperty

class CfnResourceDefinition.S3MachineLearningModelResourceDataProperty(*, destination_path, s3_uri, owner_setting=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 AWS CloudFormation template, S3MachineLearningModelResourceData can be used in the `ResourceDataContainer <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html>`_ property type.

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-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.
import aws_cdk.aws_greengrass as greengrass

s3_machine_learning_model_resource_data_property = greengrass.CfnResourceDefinition.S3MachineLearningModelResourceDataProperty(
    destination_path="destinationPath",
    s3_uri="s3Uri",

    # the properties below are optional
    owner_setting=greengrass.CfnResourceDefinition.ResourceDownloadOwnerSettingProperty(
        group_owner="groupOwner",
        group_permission="groupPermission"
    )
)

Attributes

destination_path

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

Link

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

Return type

str

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 .

Link

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

Return type

Union[IResolvable, ResourceDownloadOwnerSettingProperty, None]

s3_uri

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

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

Link

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

Return type

str

SageMakerMachineLearningModelResourceDataProperty

class CfnResourceDefinition.SageMakerMachineLearningModelResourceDataProperty(*, destination_path, sage_maker_job_arn, owner_setting=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 AWS CloudFormation template, SageMakerMachineLearningModelResourceData can be used in the `ResourceDataContainer <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html>`_ property type.

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-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.
import aws_cdk.aws_greengrass as greengrass

sage_maker_machine_learning_model_resource_data_property = greengrass.CfnResourceDefinition.SageMakerMachineLearningModelResourceDataProperty(
    destination_path="destinationPath",
    sage_maker_job_arn="sageMakerJobArn",

    # the properties below are optional
    owner_setting=greengrass.CfnResourceDefinition.ResourceDownloadOwnerSettingProperty(
        group_owner="groupOwner",
        group_permission="groupPermission"
    )
)

Attributes

destination_path

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

Link

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

Return type

str

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 .

Link

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

Return type

Union[IResolvable, ResourceDownloadOwnerSettingProperty, None]

sage_maker_job_arn

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

Link

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

Return type

str

SecretsManagerSecretResourceDataProperty

class CfnResourceDefinition.SecretsManagerSecretResourceDataProperty(*, arn, additional_staging_labels_to_download=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 AWS CloudFormation template, SecretsManagerSecretResourceData can be used in the `ResourceDataContainer <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-resourcedatacontainer.html>`_ property type.

Parameters
  • arn (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.

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinition-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.
import aws_cdk.aws_greengrass as greengrass

secrets_manager_secret_resource_data_property = greengrass.CfnResourceDefinition.SecretsManagerSecretResourceDataProperty(
    arn="arn",

    # the properties below are optional
    additional_staging_labels_to_download=["additionalStagingLabelsToDownload"]
)

Attributes

additional_staging_labels_to_download

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

Link

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

Return type

Optional[List[str]]

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.

Link

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

Return type

str