Skip to main content

component_version_artifacts

Creates, updates, deletes, gets or lists a component_version_artifacts resource.

Overview

Namecomponent_version_artifacts
TypeResource
Idaws.greengrassv2.component_version_artifacts

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
pre_signed_urlstringThe URL of the artifact.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_component_version_artifactselectarn, artifact_name, regions3EndpointType, x-amz-iot-endpoint-typeGets the pre-signed URL to download a public or a Lambda component artifact. Core devices call this operation to identify the URL that they can use to download an artifact to install.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
arnstringThe ARN of the component version. Specify the ARN of a public or a Lambda component version.
artifact_namestringThe name of the artifact. You can use the GetComponent operation to download the component recipe, which includes the URI of the artifact. The artifact name is the section of the URI after the scheme. For example, in the artifact URI greengrass:SomeArtifact.zip, the artifact name is SomeArtifact.zip.
regionstringAWS region (default: us-east-1)
s3EndpointTypestringSpecifies the endpoint to use when getting Amazon S3 pre-signed URLs. All Amazon Web Services Regions except US East (N. Virginia) use REGIONAL in all cases. In the US East (N. Virginia) Region the default is GLOBAL, but you can change it to REGIONAL with this parameter.
x-amz-iot-endpoint-typestringDetermines if the Amazon S3 URL returned is a FIPS pre-signed URL endpoint. Specify fips if you want the returned Amazon S3 pre-signed URL to point to an Amazon S3 FIPS endpoint. If you don't specify a value, the default is standard.

SELECT examples

Gets the pre-signed URL to download a public or a Lambda component artifact. Core devices call this operation to identify the URL that they can use to download an artifact to install.

SELECT
pre_signed_url
FROM aws.greengrassv2.component_version_artifacts
WHERE arn = '{{ arn }}' -- required
AND artifact_name = '{{ artifact_name }}' -- required
AND region = '{{ region }}' -- required
AND s3EndpointType = '{{ s3EndpointType }}'
AND `x-amz-iot-endpoint-type` = '{{ x-amz-iot-endpoint-type }}'
;