mbr_s3_link

Usage

This shortcode generates an Amazon S3/Cloudfront self-expiring URL.

Important

For more details regarding configuring Amazon S3/Cloudfront for use with ActiveMember360 please reference ActiveMember360, Settings, Amazon S3 before using this shortcode.

This shortcode generates a URL with a number of Amazon S3 specific parameters. Some video player plugins/shortcodes are not able to handle these types of URLs. Please note that we cannot provide support for those plugins and shortcodes.

Parameters

Parameters	Description
s3key	Your S3 access key as provided by Amazon AWS. Default: As specified within ActiveMember360, Settings, Amazon S3, S3 access key. Required: no.
s3secret	Your S3 secret key as provided by Amazon AWS. Defaults: As specified within ActiveMember360, Settings, Amazon S3, S3 secret key. Required: no.
protocol	The protocol for generating the URL. Use this parameter when creating download links i.e HTML tag <a>. Do not specify when building a URL for video and audio players. Permitted Values: http, https Default: https Required: no.
host	The full CNAME to your S3 host, excluding http:// or https://. Typically this will be s3.amazonaws.com Default: As specified within ActiveMember360, Settings, Amazon S3, Default S3 host. Required: no.
bucket	The name of your S3 bucket where the object is located. Default: As specified within ActiveMember360, Settings, Amazon S3, Default S3 bucket. Required: no.
object	The file name for which a self-expiring link should be generated. If the file is located in a folder, specify the file path relative to the bucket. Default: none. Required: yes.
expire	The number of seconds after which any generated link should expire. Default: As specified within ActiveMember360, Settings, Amazon S3, Default expiration in seconds. Required: no.

Validity

This shortcode is evaluated for any type of visitor.

Conditional Branching

This shortcode does NOT support conditional branching with [ELSE_s3_link].

Nesting

Shortcode nesting is NOT supported.

Examples

Example 1

Generate an Amazon S3 self expiring URL lasting 300 seconds using the https protocol for the file named overview.pdf found in the folder pdf of the Amazon S3 account with remaining settings as specified in ActiveMember360, Settings, Amazon S3.

[mbr_s3_link object='pdf/overview.pdf']

Example 2

Generate an Amazon S3 self expiring URL lasting 300 seconds using the https protocol for the file named overview.pdf found in the folder pdf and bucket bucketname of the Amazon S3 account with remaining settings as specified in ActiveMember360, Settings, Amazon S3.

[mbr_s3_link bucket='bucketname' object='pdf/overview.pdf']

Example 3

Generate an Amazon S3 self expiring URL lasting 300 seconds using the https protocol for the file named overview.pdf found in the folder pdf and bucket bucketname of the Amazon S3 account with remaining settings as specified in ActiveMember360, Settings, Amazon S3.

[mbr_s3_link protocol='https' bucket='bucketname' object='pdf/overview.pdf']

Example 4

Generate an Amazon S3 self expiring URL lasting 240 seconds using the https protocol for the file named overview.pdf found in the folder pdf, bucket bucketname and host s3.amazon.aws of the Amazon S3 account with remaining settings as specified in ActiveMember360, Settings, Amazon S3.

[mbr_s3_link protocol='https' host='s3.amazonaws.com' object='pdf/overview.pdf' expire='240']

API

info

There is currently no ActiveMember360 API function equivalent for this shortcode.