CfnResourceDefinitionVersion
- class aws_cdk.aws_greengrass.CfnResourceDefinitionVersion(scope, id, *, resource_definition_id, resources)
Bases:
CfnResourceThe
AWS::Greengrass::ResourceDefinitionVersionresource represents a resource definition version for AWS IoT Greengrass .A resource definition version contains a list of resources. (In AWS 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:
- CloudformationResource:
AWS::Greengrass::ResourceDefinitionVersion
- 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 import aws_greengrass as greengrass cfn_resource_definition_version = greengrass.CfnResourceDefinitionVersion(self, "MyCfnResourceDefinitionVersion", resource_definition_id="resourceDefinitionId", resources=[greengrass.CfnResourceDefinitionVersion.ResourceInstanceProperty( id="id", name="name", resource_data_container=greengrass.CfnResourceDefinitionVersion.ResourceDataContainerProperty( local_device_resource_data=greengrass.CfnResourceDefinitionVersion.LocalDeviceResourceDataProperty( source_path="sourcePath", # the properties below are optional group_owner_setting=greengrass.CfnResourceDefinitionVersion.GroupOwnerSettingProperty( auto_add_group_owner=False, # the properties below are optional group_owner="groupOwner" ) ), local_volume_resource_data=greengrass.CfnResourceDefinitionVersion.LocalVolumeResourceDataProperty( destination_path="destinationPath", source_path="sourcePath", # the properties below are optional group_owner_setting=greengrass.CfnResourceDefinitionVersion.GroupOwnerSettingProperty( auto_add_group_owner=False, # the properties below are optional group_owner="groupOwner" ) ), s3_machine_learning_model_resource_data=greengrass.CfnResourceDefinitionVersion.S3MachineLearningModelResourceDataProperty( destination_path="destinationPath", s3_uri="s3Uri", # the properties below are optional owner_setting=greengrass.CfnResourceDefinitionVersion.ResourceDownloadOwnerSettingProperty( group_owner="groupOwner", group_permission="groupPermission" ) ), sage_maker_machine_learning_model_resource_data=greengrass.CfnResourceDefinitionVersion.SageMakerMachineLearningModelResourceDataProperty( destination_path="destinationPath", sage_maker_job_arn="sageMakerJobArn", # the properties below are optional owner_setting=greengrass.CfnResourceDefinitionVersion.ResourceDownloadOwnerSettingProperty( group_owner="groupOwner", group_permission="groupPermission" ) ), secrets_manager_secret_resource_data=greengrass.CfnResourceDefinitionVersion.SecretsManagerSecretResourceDataProperty( arn="arn", # the properties below are optional additional_staging_labels_to_download=["additionalStagingLabelsToDownload"] ) ) )] )
- Parameters:
scope (
Construct) – Scope in which this resource is defined.id (
str) – Construct identifier for this resource (unique in its scope).resource_definition_id (
str) – The ID of the resource definition associated with this version. This value is a GUID.resources (
Union[IResolvable,Sequence[Union[IResolvable,ResourceInstanceProperty,Dict[str,Any]]]]) – The resources in this version.
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_dependency(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_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str) –value (
Any) –
- See:
- Return type:
None
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.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “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
valueargument toaddOverridewill 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 intermediate 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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional[RemovalPolicy]) –apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
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 resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
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.type_hint (
Optional[ResolutionTypeHint]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str) –- See:
- Return type:
Any
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.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List[Union[Stack,CfnResource]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List[CfnResource]
- 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
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource) – The dependency to replace.new_target (
CfnResource) – The new dependency to add.
- 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::ResourceDefinitionVersion'
- attr_id
Id
- Type:
cloudformationAttribute
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- 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.
- 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).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- node
The tree node.
- 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 }).
- resource_definition_id
The ID of the resource definition associated with this version.
- resources
The resources in this version.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto 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(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any) –- Return type:
bool
- classmethod is_construct(x)
Checks if
xis a construct.Use this method instead of
instanceofto properly detectConstructinstances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructslibrary on disk are seen as independent, completely different libraries. As a consequence, the classConstructin each copy of theconstructslibrary is seen as a different class, and an instance of one class will not test asinstanceofthe other class.npm installwill not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructslibrary can be accidentally installed, andinstanceofwill behave unpredictably. It is safest to avoid usinginstanceof, and using this type-testing method instead.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsConstruct.
GroupOwnerSettingProperty
- class CfnResourceDefinitionVersion.GroupOwnerSettingProperty(*, auto_add_group_owner, group_owner=None)
Bases:
objectSettings 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
RunAspermissions.In an AWS CloudFormation template,
GroupOwnerSettingis 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]) – 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 ifAutoAddGroupOwneris true.
- See:
- 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 import aws_greengrass as greengrass group_owner_setting_property = greengrass.CfnResourceDefinitionVersion.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.
- group_owner
The name of the Linux group whose privileges you want to add to the Lambda process.
This value is ignored if
AutoAddGroupOwneris true.
LocalDeviceResourceDataProperty
- class CfnResourceDefinitionVersion.LocalDeviceResourceDataProperty(*, source_path, group_owner_setting=None)
Bases:
objectSettings 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,
LocalDeviceResourceDatacan be used in the`ResourceDataContainer<https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-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.
- See:
- 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 import aws_greengrass as greengrass local_device_resource_data_property = greengrass.CfnResourceDefinitionVersion.LocalDeviceResourceDataProperty( source_path="sourcePath", # the properties below are optional group_owner_setting=greengrass.CfnResourceDefinitionVersion.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.
- 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.
LocalVolumeResourceDataProperty
- class CfnResourceDefinitionVersion.LocalVolumeResourceDataProperty(*, destination_path, source_path, group_owner_setting=None)
Bases:
objectSettings 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,
LocalVolumeResourceDatacan be used in the`ResourceDataContainer<https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-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.
- See:
- 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 import aws_greengrass as greengrass local_volume_resource_data_property = greengrass.CfnResourceDefinitionVersion.LocalVolumeResourceDataProperty( destination_path="destinationPath", source_path="sourcePath", # the properties below are optional group_owner_setting=greengrass.CfnResourceDefinitionVersion.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.
- group_owner_setting
Settings that define additional Linux OS group permissions to give to the Lambda function process.
- 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.
ResourceDataContainerProperty
- class CfnResourceDefinitionVersion.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:
objectA 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, orSecretsManagerSecretResourceData. .. epigraph:Only one resource type can be defined for a ``ResourceDataContainer`` instance.
In an AWS CloudFormation template,
ResourceDataContaineris a property of the`ResourceInstance<https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourceinstance.html>`_ property type.- Parameters:
local_device_resource_data (
Union[IResolvable,LocalDeviceResourceDataProperty,Dict[str,Any],None]) – Settings for a local device resource.local_volume_resource_data (
Union[IResolvable,LocalVolumeResourceDataProperty,Dict[str,Any],None]) – Settings for a local volume resource.s3_machine_learning_model_resource_data (
Union[IResolvable,S3MachineLearningModelResourceDataProperty,Dict[str,Any],None]) – Settings for a machine learning resource stored in Amazon S3 .sage_maker_machine_learning_model_resource_data (
Union[IResolvable,SageMakerMachineLearningModelResourceDataProperty,Dict[str,Any],None]) – Settings for a machine learning resource saved as an SageMaker training job.secrets_manager_secret_resource_data (
Union[IResolvable,SecretsManagerSecretResourceDataProperty,Dict[str,Any],None]) – Settings for a secret resource.
- See:
- 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 import aws_greengrass as greengrass resource_data_container_property = greengrass.CfnResourceDefinitionVersion.ResourceDataContainerProperty( local_device_resource_data=greengrass.CfnResourceDefinitionVersion.LocalDeviceResourceDataProperty( source_path="sourcePath", # the properties below are optional group_owner_setting=greengrass.CfnResourceDefinitionVersion.GroupOwnerSettingProperty( auto_add_group_owner=False, # the properties below are optional group_owner="groupOwner" ) ), local_volume_resource_data=greengrass.CfnResourceDefinitionVersion.LocalVolumeResourceDataProperty( destination_path="destinationPath", source_path="sourcePath", # the properties below are optional group_owner_setting=greengrass.CfnResourceDefinitionVersion.GroupOwnerSettingProperty( auto_add_group_owner=False, # the properties below are optional group_owner="groupOwner" ) ), s3_machine_learning_model_resource_data=greengrass.CfnResourceDefinitionVersion.S3MachineLearningModelResourceDataProperty( destination_path="destinationPath", s3_uri="s3Uri", # the properties below are optional owner_setting=greengrass.CfnResourceDefinitionVersion.ResourceDownloadOwnerSettingProperty( group_owner="groupOwner", group_permission="groupPermission" ) ), sage_maker_machine_learning_model_resource_data=greengrass.CfnResourceDefinitionVersion.SageMakerMachineLearningModelResourceDataProperty( destination_path="destinationPath", sage_maker_job_arn="sageMakerJobArn", # the properties below are optional owner_setting=greengrass.CfnResourceDefinitionVersion.ResourceDownloadOwnerSettingProperty( group_owner="groupOwner", group_permission="groupPermission" ) ), secrets_manager_secret_resource_data=greengrass.CfnResourceDefinitionVersion.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.
- local_volume_resource_data
Settings for a local volume resource.
- s3_machine_learning_model_resource_data
Settings for a machine learning resource stored in Amazon S3 .
- sage_maker_machine_learning_model_resource_data
Settings for a machine learning resource saved as an SageMaker training job.
- secrets_manager_secret_resource_data
Settings for a secret resource.
ResourceDownloadOwnerSettingProperty
- class CfnResourceDefinitionVersion.ResourceDownloadOwnerSettingProperty(*, group_owner, group_permission)
Bases:
objectThe 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,
ResourceDownloadOwnerSettingis the property type of theOwnerSettingproperty 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 (
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 arerw(read-write) orro(read-only).
- See:
- 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 import aws_greengrass as greengrass resource_download_owner_setting_property = greengrass.CfnResourceDefinitionVersion.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.
- group_permission
The permissions that the group owner has to the machine learning resource.
Valid values are
rw(read-write) orro(read-only).
ResourceInstanceProperty
- class CfnResourceDefinitionVersion.ResourceInstanceProperty(*, id, name, resource_data_container)
Bases:
objectA 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
Resourcesproperty of the`AWS::Greengrass::ResourceDefinitionVersion<https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-greengrass-resourcedefinitionversion.html>`_ resource contains a list ofResourceInstanceproperty 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, orSecretsManagerSecretResourceData. .. epigraph:: Only one resource type can be defined for aResourceDataContainerinstance.
- See:
- 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 import aws_greengrass as greengrass resource_instance_property = greengrass.CfnResourceDefinitionVersion.ResourceInstanceProperty( id="id", name="name", resource_data_container=greengrass.CfnResourceDefinitionVersion.ResourceDataContainerProperty( local_device_resource_data=greengrass.CfnResourceDefinitionVersion.LocalDeviceResourceDataProperty( source_path="sourcePath", # the properties below are optional group_owner_setting=greengrass.CfnResourceDefinitionVersion.GroupOwnerSettingProperty( auto_add_group_owner=False, # the properties below are optional group_owner="groupOwner" ) ), local_volume_resource_data=greengrass.CfnResourceDefinitionVersion.LocalVolumeResourceDataProperty( destination_path="destinationPath", source_path="sourcePath", # the properties below are optional group_owner_setting=greengrass.CfnResourceDefinitionVersion.GroupOwnerSettingProperty( auto_add_group_owner=False, # the properties below are optional group_owner="groupOwner" ) ), s3_machine_learning_model_resource_data=greengrass.CfnResourceDefinitionVersion.S3MachineLearningModelResourceDataProperty( destination_path="destinationPath", s3_uri="s3Uri", # the properties below are optional owner_setting=greengrass.CfnResourceDefinitionVersion.ResourceDownloadOwnerSettingProperty( group_owner="groupOwner", group_permission="groupPermission" ) ), sage_maker_machine_learning_model_resource_data=greengrass.CfnResourceDefinitionVersion.SageMakerMachineLearningModelResourceDataProperty( destination_path="destinationPath", sage_maker_job_arn="sageMakerJobArn", # the properties below are optional owner_setting=greengrass.CfnResourceDefinitionVersion.ResourceDownloadOwnerSettingProperty( group_owner="groupOwner", group_permission="groupPermission" ) ), secrets_manager_secret_resource_data=greengrass.CfnResourceDefinitionVersion.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:_-]+.
- 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.
- resource_data_container
A container for resource data.
The container takes only one of the following supported resource data types:
LocalDeviceResourceData,LocalVolumeResourceData,SageMakerMachineLearningModelResourceData,S3MachineLearningModelResourceData, orSecretsManagerSecretResourceData. .. epigraph:Only one resource type can be defined for a ``ResourceDataContainer`` instance.
S3MachineLearningModelResourceDataProperty
- class CfnResourceDefinitionVersion.S3MachineLearningModelResourceDataProperty(*, destination_path, s3_uri, owner_setting=None)
Bases:
objectSettings for an Amazon S3 machine learning resource.
For more information, see Perform Machine Learning Inference in the Developer Guide .
In an AWS CloudFormation template,
S3MachineLearningModelResourceDatacan be used in the`ResourceDataContainer<https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html>`_ property type.- Parameters:
destination_path (
str) – The absolute local path of the resource inside the Lambda environment.s3_uri (
str) – The URI of the source model in an Amazon S3 bucket. The model package must be intar.gzor.zipformat.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 .
- See:
- 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 import aws_greengrass as greengrass s3_machine_learning_model_resource_data_property = greengrass.CfnResourceDefinitionVersion.S3MachineLearningModelResourceDataProperty( destination_path="destinationPath", s3_uri="s3Uri", # the properties below are optional owner_setting=greengrass.CfnResourceDefinitionVersion.ResourceDownloadOwnerSettingProperty( group_owner="groupOwner", group_permission="groupPermission" ) )
Attributes
- destination_path
The absolute local path of the resource inside the Lambda environment.
- 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 .
- s3_uri
The URI of the source model in an Amazon S3 bucket.
The model package must be in
tar.gzor.zipformat.
SageMakerMachineLearningModelResourceDataProperty
- class CfnResourceDefinitionVersion.SageMakerMachineLearningModelResourceDataProperty(*, destination_path, sage_maker_job_arn, owner_setting=None)
Bases:
objectSettings for an Secrets Manager machine learning resource.
For more information, see Perform Machine Learning Inference in the Developer Guide .
In an AWS CloudFormation template,
SageMakerMachineLearningModelResourceDatacan be used in the`ResourceDataContainer<https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-resourcedatacontainer.html>`_ property type.- Parameters:
destination_path (
str) – The absolute local path of the resource inside the Lambda environment.sage_maker_job_arn (
str) – The Amazon Resource Name (ARN) of the Amazon SageMaker training job that represents the source model.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 .
- See:
- 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 import aws_greengrass as greengrass sage_maker_machine_learning_model_resource_data_property = greengrass.CfnResourceDefinitionVersion.SageMakerMachineLearningModelResourceDataProperty( destination_path="destinationPath", sage_maker_job_arn="sageMakerJobArn", # the properties below are optional owner_setting=greengrass.CfnResourceDefinitionVersion.ResourceDownloadOwnerSettingProperty( group_owner="groupOwner", group_permission="groupPermission" ) )
Attributes
- destination_path
The absolute local path of the resource inside the Lambda environment.
- 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 .
- sage_maker_job_arn
The Amazon Resource Name (ARN) of the Amazon SageMaker training job that represents the source model.
SecretsManagerSecretResourceDataProperty
- class CfnResourceDefinitionVersion.SecretsManagerSecretResourceDataProperty(*, arn, additional_staging_labels_to_download=None)
Bases:
objectSettings 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,
SecretsManagerSecretResourceDatacan be used in the`ResourceDataContainer<https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-greengrass-resourcedefinitionversion-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 theAWSCURRENTstaging 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 toAWSCURRENT.
- See:
- 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 import aws_greengrass as greengrass secrets_manager_secret_resource_data_property = greengrass.CfnResourceDefinitionVersion.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.
- 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
AWSCURRENTstaging label) is included by default.