AWS SDK for C++  1.9.69
AWS SDK for C++
Public Member Functions | List of all members
Aws::ElasticTranscoder::Model::Pipeline Class Reference

#include <Pipeline.h>

Public Member Functions

 Pipeline ()
 
 Pipeline (Aws::Utils::Json::JsonView jsonValue)
 
Pipelineoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
PipelineWithId (const Aws::String &value)
 
PipelineWithId (Aws::String &&value)
 
PipelineWithId (const char *value)
 
const Aws::StringGetArn () const
 
bool ArnHasBeenSet () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
PipelineWithArn (const Aws::String &value)
 
PipelineWithArn (Aws::String &&value)
 
PipelineWithArn (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
PipelineWithName (const Aws::String &value)
 
PipelineWithName (Aws::String &&value)
 
PipelineWithName (const char *value)
 
const Aws::StringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const Aws::String &value)
 
void SetStatus (Aws::String &&value)
 
void SetStatus (const char *value)
 
PipelineWithStatus (const Aws::String &value)
 
PipelineWithStatus (Aws::String &&value)
 
PipelineWithStatus (const char *value)
 
const Aws::StringGetInputBucket () const
 
bool InputBucketHasBeenSet () const
 
void SetInputBucket (const Aws::String &value)
 
void SetInputBucket (Aws::String &&value)
 
void SetInputBucket (const char *value)
 
PipelineWithInputBucket (const Aws::String &value)
 
PipelineWithInputBucket (Aws::String &&value)
 
PipelineWithInputBucket (const char *value)
 
const Aws::StringGetOutputBucket () const
 
bool OutputBucketHasBeenSet () const
 
void SetOutputBucket (const Aws::String &value)
 
void SetOutputBucket (Aws::String &&value)
 
void SetOutputBucket (const char *value)
 
PipelineWithOutputBucket (const Aws::String &value)
 
PipelineWithOutputBucket (Aws::String &&value)
 
PipelineWithOutputBucket (const char *value)
 
const Aws::StringGetRole () const
 
bool RoleHasBeenSet () const
 
void SetRole (const Aws::String &value)
 
void SetRole (Aws::String &&value)
 
void SetRole (const char *value)
 
PipelineWithRole (const Aws::String &value)
 
PipelineWithRole (Aws::String &&value)
 
PipelineWithRole (const char *value)
 
const Aws::StringGetAwsKmsKeyArn () const
 
bool AwsKmsKeyArnHasBeenSet () const
 
void SetAwsKmsKeyArn (const Aws::String &value)
 
void SetAwsKmsKeyArn (Aws::String &&value)
 
void SetAwsKmsKeyArn (const char *value)
 
PipelineWithAwsKmsKeyArn (const Aws::String &value)
 
PipelineWithAwsKmsKeyArn (Aws::String &&value)
 
PipelineWithAwsKmsKeyArn (const char *value)
 
const NotificationsGetNotifications () const
 
bool NotificationsHasBeenSet () const
 
void SetNotifications (const Notifications &value)
 
void SetNotifications (Notifications &&value)
 
PipelineWithNotifications (const Notifications &value)
 
PipelineWithNotifications (Notifications &&value)
 
const PipelineOutputConfigGetContentConfig () const
 
bool ContentConfigHasBeenSet () const
 
void SetContentConfig (const PipelineOutputConfig &value)
 
void SetContentConfig (PipelineOutputConfig &&value)
 
PipelineWithContentConfig (const PipelineOutputConfig &value)
 
PipelineWithContentConfig (PipelineOutputConfig &&value)
 
const PipelineOutputConfigGetThumbnailConfig () const
 
bool ThumbnailConfigHasBeenSet () const
 
void SetThumbnailConfig (const PipelineOutputConfig &value)
 
void SetThumbnailConfig (PipelineOutputConfig &&value)
 
PipelineWithThumbnailConfig (const PipelineOutputConfig &value)
 
PipelineWithThumbnailConfig (PipelineOutputConfig &&value)
 

Detailed Description

The pipeline (queue) that is used to manage jobs.

See Also:


AWS API Reference

Definition at line 34 of file Pipeline.h.

Constructor & Destructor Documentation

◆ Pipeline() [1/2]

Aws::ElasticTranscoder::Model::Pipeline::Pipeline ( )

◆ Pipeline() [2/2]

Aws::ElasticTranscoder::Model::Pipeline::Pipeline ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ArnHasBeenSet()

bool Aws::ElasticTranscoder::Model::Pipeline::ArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) for the pipeline.

Definition at line 108 of file Pipeline.h.

◆ AwsKmsKeyArnHasBeenSet()

bool Aws::ElasticTranscoder::Model::Pipeline::AwsKmsKeyArnHasBeenSet ( ) const
inline

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.

Definition at line 438 of file Pipeline.h.

◆ ContentConfigHasBeenSet()

bool Aws::ElasticTranscoder::Model::Pipeline::ContentConfigHasBeenSet ( ) const
inline

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

  • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have.

    • GranteeType: The type of value that appears in the Grantee object:

      • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

      • Email: The registered email address of an AWS account.

      • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to transcoded files and playlists.

    • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

      • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

Definition at line 670 of file Pipeline.h.

◆ GetArn()

const Aws::String& Aws::ElasticTranscoder::Model::Pipeline::GetArn ( ) const
inline

The Amazon Resource Name (ARN) for the pipeline.

Definition at line 103 of file Pipeline.h.

◆ GetAwsKmsKeyArn()

const Aws::String& Aws::ElasticTranscoder::Model::Pipeline::GetAwsKmsKeyArn ( ) const
inline

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.

Definition at line 427 of file Pipeline.h.

◆ GetContentConfig()

const PipelineOutputConfig& Aws::ElasticTranscoder::Model::Pipeline::GetContentConfig ( ) const
inline

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

  • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have.

    • GranteeType: The type of value that appears in the Grantee object:

      • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

      • Email: The registered email address of an AWS account.

      • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to transcoded files and playlists.

    • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

      • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

Definition at line 636 of file Pipeline.h.

◆ GetId()

const Aws::String& Aws::ElasticTranscoder::Model::Pipeline::GetId ( ) const
inline

The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

Definition at line 48 of file Pipeline.h.

◆ GetInputBucket()

const Aws::String& Aws::ElasticTranscoder::Model::Pipeline::GetInputBucket ( ) const
inline

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.

Definition at line 260 of file Pipeline.h.

◆ GetName()

const Aws::String& Aws::ElasticTranscoder::Model::Pipeline::GetName ( ) const
inline

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

Definition at line 146 of file Pipeline.h.

◆ GetNotifications()

const Notifications& Aws::ElasticTranscoder::Model::Pipeline::GetNotifications ( ) const
inline

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

  • Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

  • Complete (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

  • Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

  • Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

Definition at line 521 of file Pipeline.h.

◆ GetOutputBucket()

const Aws::String& Aws::ElasticTranscoder::Model::Pipeline::GetOutputBucket ( ) const
inline

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig.

Definition at line 317 of file Pipeline.h.

◆ GetRole()

const Aws::String& Aws::ElasticTranscoder::Model::Pipeline::GetRole ( ) const
inline

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.

Definition at line 373 of file Pipeline.h.

◆ GetStatus()

const Aws::String& Aws::ElasticTranscoder::Model::Pipeline::GetStatus ( ) const
inline

The current status of the pipeline:

  • Active: The pipeline is processing jobs.

  • Paused: The pipeline is not currently processing jobs.

Definition at line 203 of file Pipeline.h.

◆ GetThumbnailConfig()

const PipelineOutputConfig& Aws::ElasticTranscoder::Model::Pipeline::GetThumbnailConfig ( ) const
inline

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

  • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have.

    • GranteeType: The type of value that appears in the Grantee object:

      • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

        A canonical user ID is not the same as an AWS account number.

      • Email: The registered email address of an AWS account.

      • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to thumbnail files.

    • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

      • READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

Definition at line 842 of file Pipeline.h.

◆ IdHasBeenSet()

bool Aws::ElasticTranscoder::Model::Pipeline::IdHasBeenSet ( ) const
inline

The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

Definition at line 55 of file Pipeline.h.

◆ InputBucketHasBeenSet()

bool Aws::ElasticTranscoder::Model::Pipeline::InputBucketHasBeenSet ( ) const
inline

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.

Definition at line 267 of file Pipeline.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ElasticTranscoder::Model::Pipeline::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::ElasticTranscoder::Model::Pipeline::NameHasBeenSet ( ) const
inline

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

Definition at line 153 of file Pipeline.h.

◆ NotificationsHasBeenSet()

bool Aws::ElasticTranscoder::Model::Pipeline::NotificationsHasBeenSet ( ) const
inline

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

  • Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

  • Complete (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

  • Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

  • Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

Definition at line 537 of file Pipeline.h.

◆ operator=()

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OutputBucketHasBeenSet()

bool Aws::ElasticTranscoder::Model::Pipeline::OutputBucketHasBeenSet ( ) const
inline

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig.

Definition at line 324 of file Pipeline.h.

◆ RoleHasBeenSet()

bool Aws::ElasticTranscoder::Model::Pipeline::RoleHasBeenSet ( ) const
inline

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.

Definition at line 379 of file Pipeline.h.

◆ SetArn() [1/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the pipeline.

Definition at line 118 of file Pipeline.h.

◆ SetArn() [2/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the pipeline.

Definition at line 113 of file Pipeline.h.

◆ SetArn() [3/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for the pipeline.

Definition at line 123 of file Pipeline.h.

◆ SetAwsKmsKeyArn() [1/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetAwsKmsKeyArn ( Aws::String &&  value)
inline

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.

Definition at line 460 of file Pipeline.h.

◆ SetAwsKmsKeyArn() [2/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetAwsKmsKeyArn ( const Aws::String value)
inline

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.

Definition at line 449 of file Pipeline.h.

◆ SetAwsKmsKeyArn() [3/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetAwsKmsKeyArn ( const char *  value)
inline

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.

Definition at line 471 of file Pipeline.h.

◆ SetContentConfig() [1/2]

void Aws::ElasticTranscoder::Model::Pipeline::SetContentConfig ( const PipelineOutputConfig value)
inline

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

  • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have.

    • GranteeType: The type of value that appears in the Grantee object:

      • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

      • Email: The registered email address of an AWS account.

      • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to transcoded files and playlists.

    • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

      • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

Definition at line 704 of file Pipeline.h.

◆ SetContentConfig() [2/2]

void Aws::ElasticTranscoder::Model::Pipeline::SetContentConfig ( PipelineOutputConfig &&  value)
inline

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

  • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have.

    • GranteeType: The type of value that appears in the Grantee object:

      • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

      • Email: The registered email address of an AWS account.

      • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to transcoded files and playlists.

    • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

      • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

Definition at line 738 of file Pipeline.h.

◆ SetId() [1/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetId ( Aws::String &&  value)
inline

The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

Definition at line 69 of file Pipeline.h.

◆ SetId() [2/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetId ( const Aws::String value)
inline

The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

Definition at line 62 of file Pipeline.h.

◆ SetId() [3/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetId ( const char *  value)
inline

The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

Definition at line 76 of file Pipeline.h.

◆ SetInputBucket() [1/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetInputBucket ( Aws::String &&  value)
inline

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.

Definition at line 281 of file Pipeline.h.

◆ SetInputBucket() [2/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetInputBucket ( const Aws::String value)
inline

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.

Definition at line 274 of file Pipeline.h.

◆ SetInputBucket() [3/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetInputBucket ( const char *  value)
inline

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.

Definition at line 288 of file Pipeline.h.

◆ SetName() [1/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetName ( Aws::String &&  value)
inline

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

Definition at line 167 of file Pipeline.h.

◆ SetName() [2/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetName ( const Aws::String value)
inline

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

Definition at line 160 of file Pipeline.h.

◆ SetName() [3/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetName ( const char *  value)
inline

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

Definition at line 174 of file Pipeline.h.

◆ SetNotifications() [1/2]

void Aws::ElasticTranscoder::Model::Pipeline::SetNotifications ( const Notifications value)
inline

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

  • Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

  • Complete (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

  • Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

  • Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

Definition at line 553 of file Pipeline.h.

◆ SetNotifications() [2/2]

void Aws::ElasticTranscoder::Model::Pipeline::SetNotifications ( Notifications &&  value)
inline

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

  • Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

  • Complete (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

  • Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

  • Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

Definition at line 569 of file Pipeline.h.

◆ SetOutputBucket() [1/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetOutputBucket ( Aws::String &&  value)
inline

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig.

Definition at line 338 of file Pipeline.h.

◆ SetOutputBucket() [2/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetOutputBucket ( const Aws::String value)
inline

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig.

Definition at line 331 of file Pipeline.h.

◆ SetOutputBucket() [3/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetOutputBucket ( const char *  value)
inline

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig.

Definition at line 345 of file Pipeline.h.

◆ SetRole() [1/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetRole ( Aws::String &&  value)
inline

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.

Definition at line 391 of file Pipeline.h.

◆ SetRole() [2/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetRole ( const Aws::String value)
inline

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.

Definition at line 385 of file Pipeline.h.

◆ SetRole() [3/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetRole ( const char *  value)
inline

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.

Definition at line 397 of file Pipeline.h.

◆ SetStatus() [1/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetStatus ( Aws::String &&  value)
inline

The current status of the pipeline:

  • Active: The pipeline is processing jobs.

  • Paused: The pipeline is not currently processing jobs.

Definition at line 224 of file Pipeline.h.

◆ SetStatus() [2/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetStatus ( const Aws::String value)
inline

The current status of the pipeline:

  • Active: The pipeline is processing jobs.

  • Paused: The pipeline is not currently processing jobs.

Definition at line 217 of file Pipeline.h.

◆ SetStatus() [3/3]

void Aws::ElasticTranscoder::Model::Pipeline::SetStatus ( const char *  value)
inline

The current status of the pipeline:

  • Active: The pipeline is processing jobs.

  • Paused: The pipeline is not currently processing jobs.

Definition at line 231 of file Pipeline.h.

◆ SetThumbnailConfig() [1/2]

void Aws::ElasticTranscoder::Model::Pipeline::SetThumbnailConfig ( const PipelineOutputConfig value)
inline

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

  • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have.

    • GranteeType: The type of value that appears in the Grantee object:

      • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

        A canonical user ID is not the same as an AWS account number.

      • Email: The registered email address of an AWS account.

      • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to thumbnail files.

    • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

      • READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

Definition at line 912 of file Pipeline.h.

◆ SetThumbnailConfig() [2/2]

void Aws::ElasticTranscoder::Model::Pipeline::SetThumbnailConfig ( PipelineOutputConfig &&  value)
inline

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

  • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have.

    • GranteeType: The type of value that appears in the Grantee object:

      • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

        A canonical user ID is not the same as an AWS account number.

      • Email: The registered email address of an AWS account.

      • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to thumbnail files.

    • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

      • READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

Definition at line 947 of file Pipeline.h.

◆ StatusHasBeenSet()

bool Aws::ElasticTranscoder::Model::Pipeline::StatusHasBeenSet ( ) const
inline

The current status of the pipeline:

  • Active: The pipeline is processing jobs.

  • Paused: The pipeline is not currently processing jobs.

Definition at line 210 of file Pipeline.h.

◆ ThumbnailConfigHasBeenSet()

bool Aws::ElasticTranscoder::Model::Pipeline::ThumbnailConfigHasBeenSet ( ) const
inline

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

  • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have.

    • GranteeType: The type of value that appears in the Grantee object:

      • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

        A canonical user ID is not the same as an AWS account number.

      • Email: The registered email address of an AWS account.

      • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to thumbnail files.

    • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

      • READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

Definition at line 877 of file Pipeline.h.

◆ WithArn() [1/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) for the pipeline.

Definition at line 133 of file Pipeline.h.

◆ WithArn() [2/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) for the pipeline.

Definition at line 128 of file Pipeline.h.

◆ WithArn() [3/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithArn ( const char *  value)
inline

The Amazon Resource Name (ARN) for the pipeline.

Definition at line 138 of file Pipeline.h.

◆ WithAwsKmsKeyArn() [1/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithAwsKmsKeyArn ( Aws::String &&  value)
inline

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.

Definition at line 493 of file Pipeline.h.

◆ WithAwsKmsKeyArn() [2/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithAwsKmsKeyArn ( const Aws::String value)
inline

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.

Definition at line 482 of file Pipeline.h.

◆ WithAwsKmsKeyArn() [3/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithAwsKmsKeyArn ( const char *  value)
inline

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.

Definition at line 504 of file Pipeline.h.

◆ WithContentConfig() [1/2]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithContentConfig ( const PipelineOutputConfig value)
inline

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

  • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have.

    • GranteeType: The type of value that appears in the Grantee object:

      • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

      • Email: The registered email address of an AWS account.

      • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to transcoded files and playlists.

    • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

      • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

Definition at line 772 of file Pipeline.h.

◆ WithContentConfig() [2/2]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithContentConfig ( PipelineOutputConfig &&  value)
inline

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

  • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have.

    • GranteeType: The type of value that appears in the Grantee object:

      • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

      • Email: The registered email address of an AWS account.

      • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to transcoded files and playlists.

    • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

      • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

Definition at line 806 of file Pipeline.h.

◆ WithId() [1/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithId ( Aws::String &&  value)
inline

The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

Definition at line 90 of file Pipeline.h.

◆ WithId() [2/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithId ( const Aws::String value)
inline

The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

Definition at line 83 of file Pipeline.h.

◆ WithId() [3/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithId ( const char *  value)
inline

The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

Definition at line 97 of file Pipeline.h.

◆ WithInputBucket() [1/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithInputBucket ( Aws::String &&  value)
inline

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.

Definition at line 302 of file Pipeline.h.

◆ WithInputBucket() [2/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithInputBucket ( const Aws::String value)
inline

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.

Definition at line 295 of file Pipeline.h.

◆ WithInputBucket() [3/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithInputBucket ( const char *  value)
inline

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.

Definition at line 309 of file Pipeline.h.

◆ WithName() [1/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithName ( Aws::String &&  value)
inline

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

Definition at line 188 of file Pipeline.h.

◆ WithName() [2/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithName ( const Aws::String value)
inline

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

Definition at line 181 of file Pipeline.h.

◆ WithName() [3/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithName ( const char *  value)
inline

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

Definition at line 195 of file Pipeline.h.

◆ WithNotifications() [1/2]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithNotifications ( const Notifications value)
inline

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

  • Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

  • Complete (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

  • Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

  • Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

Definition at line 585 of file Pipeline.h.

◆ WithNotifications() [2/2]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithNotifications ( Notifications &&  value)
inline

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

  • Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

  • Complete (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

  • Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

  • Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

Definition at line 601 of file Pipeline.h.

◆ WithOutputBucket() [1/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithOutputBucket ( Aws::String &&  value)
inline

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig.

Definition at line 359 of file Pipeline.h.

◆ WithOutputBucket() [2/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithOutputBucket ( const Aws::String value)
inline

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig.

Definition at line 352 of file Pipeline.h.

◆ WithOutputBucket() [3/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithOutputBucket ( const char *  value)
inline

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig.

Definition at line 366 of file Pipeline.h.

◆ WithRole() [1/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithRole ( Aws::String &&  value)
inline

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.

Definition at line 409 of file Pipeline.h.

◆ WithRole() [2/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithRole ( const Aws::String value)
inline

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.

Definition at line 403 of file Pipeline.h.

◆ WithRole() [3/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithRole ( const char *  value)
inline

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.

Definition at line 415 of file Pipeline.h.

◆ WithStatus() [1/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithStatus ( Aws::String &&  value)
inline

The current status of the pipeline:

  • Active: The pipeline is processing jobs.

  • Paused: The pipeline is not currently processing jobs.

Definition at line 245 of file Pipeline.h.

◆ WithStatus() [2/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithStatus ( const Aws::String value)
inline

The current status of the pipeline:

  • Active: The pipeline is processing jobs.

  • Paused: The pipeline is not currently processing jobs.

Definition at line 238 of file Pipeline.h.

◆ WithStatus() [3/3]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithStatus ( const char *  value)
inline

The current status of the pipeline:

  • Active: The pipeline is processing jobs.

  • Paused: The pipeline is not currently processing jobs.

Definition at line 252 of file Pipeline.h.

◆ WithThumbnailConfig() [1/2]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithThumbnailConfig ( const PipelineOutputConfig value)
inline

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

  • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have.

    • GranteeType: The type of value that appears in the Grantee object:

      • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

        A canonical user ID is not the same as an AWS account number.

      • Email: The registered email address of an AWS account.

      • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to thumbnail files.

    • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

      • READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

Definition at line 982 of file Pipeline.h.

◆ WithThumbnailConfig() [2/2]

Pipeline& Aws::ElasticTranscoder::Model::Pipeline::WithThumbnailConfig ( PipelineOutputConfig &&  value)
inline

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

  • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have.

    • GranteeType: The type of value that appears in the Grantee object:

      • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

        A canonical user ID is not the same as an AWS account number.

      • Email: The registered email address of an AWS account.

      • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to thumbnail files.

    • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

      • READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

Definition at line 1017 of file Pipeline.h.


The documentation for this class was generated from the following file: