public
public:Boolean
API Versions: V2
Parents: outputs OR thumbnails
Default: false
Valid Values: true or false
Compatible Job Types: VOD
Description:
By default, files put into a S3 bucket are not publicly readable. Instead, we use the canned access policy of bucket-owner-full-control. This is true even if the bucket itself is publicly readable - a S3 bucket policy is not automatically inherited by new files added to the bucket.
Use the public API setting to flag a file output to S3 as being publicly readable. This is done by granting the READ permission to the AllUsers group.
This setting applies to both output video files and output thumbnails. By default, permissions set on an output file also apply to thumbnails. Setting access_control will override this setting.
An alternative to manual permissions would be to use a bucket policy.
More information from the Amazon S3 docs.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"public": true,
"thumbnails": {
"number": 6,
"public": false
}
}
]
}
See Also: access_control and thumbnails
rrs
rrs:Boolean
API Versions: V2
Parent: outputs
Default: false
Valid Values: true or false
Compatible Job Types: VOD
Example: true
Description:
If you use Amazon S3's Reduced Redundancy Storage you can set this flag and Zencoder will pass the necessary headers to tell S3 to use RRS.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"rrs": true
}
]
}
access_control
access_control:Array
API Versions: V2
Parents: outputs OR thumbnails
Valid Values: An array of hashes containing two settings: grantee and permissions.
Compatible Job Types: VOD
Description:
The public option grants S3 READ access to all users for a given video or thumbnail. If you want more fine-grained control, use access_control. Using this setting will cause the public option to be ignored. This setting applies to both output video files and output thumbnails. By default, permissions set on an output file also apply to thumbnails.
access_control takes an array of access control grants, which each have two settings: grantee and permission.
An alternative to manual permissions would be to use a bucket policy.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"access_control": [
{
"permission": "READ",
"grantee": "someone@example.com"
}
]
}
]
}
See Also: public, grantee, and permission
grantee
grantee:String
API Versions: V2
Parents: outputs / access_control OR outputs / thumbnails / access_control
Valid Values: A valid S3 grantee (email, ID, or URI)
Compatible Job Types: VOD
Description:
A grantee for S3 permissions: user by email address, user by CanonicalUser ID, or a AWS access group (http://acs.amazonaws.com/groups/global/AuthenticatedUsers or http://acs.amazonaws.com/groups/global/AllUsers). See the S3 ACL docs for more detail.
Used as a part of the access_control setting for fine-grained S3 permissions.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"access_control": [
{
"permission": [
"READ",
"READ_ACP"
],
"grantee": "someone@example.com"
},
{
"permission": "FULL_CONTROL",
"grantee": "cdc7931a9574b1055d5b76112021d0e9"
},
{
"permission": "READ",
"grantee": "http://acs.amazonaws.com/groups/global/AllUsers"
},
{
"permission": "WRITE_ACP",
"grantee": "http://acs.amazonaws.com/groups/global/AuthenticatedUsers"
}
]
}
]
}
See Also: access_control and permission
permission
permission:String
API Versions: V2
Parents: outputs / access_control OR outputs / thumbnails / access_control
Valid Values: A string or array of strings containing: READ, READ_ACP, WRITE_ACP, or FULL_CONTROL
Compatible Job Types: VOD
Description:
A permission to give to a S3 permission grantee. See the S3 ACL docs for more detail.
- READ - read access to a file.
- READ_ACP - permission to read the Access Control Policy for the given file.
- WRITE_ACP - permission to write the Access Control Policy for the given file. Equivalent to FULL_CONTROL, since a user with WRITE_ACP could change the ACP for a file.
- FULL_CONTROL - grants READ, READ_ACP, and WRITE_ACP permissions to a file.
Used as a part of the access_control setting for fine-grained S3 permissions.
{
"input": "s3://zencodertesting/test.mov",
"outputs": [
{
"access_control": [
{
"permission": [
"READ",
"READ_ACP"
],
"grantee": "someone@example.com"
},
{
"permission": "FULL_CONTROL",
"grantee": "cdc7931a9574b1055d5b76112021d0e9"
},
{
"permission": "READ_ACP",
"grantee": "http://acs.amazonaws.com/groups/global/AllUsers"
},
{
"permission": "WRITE_ACP",
"grantee": "http://acs.amazonaws.com/groups/global/AuthenticatedUsers"
}
]
}
]
}
See Also: access_control and grantee