Class CreatePipelineRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreatePipelineRequest.Builder,
CreatePipelineRequest>
The CreatePipelineRequest
structure.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.builder()
final PipelineOutputConfig
The optionalContentConfig
object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
The Amazon S3 bucket in which you saved the media files that you want to transcode.final String
name()
The name of the pipeline.final Notifications
The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.final String
The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files.final String
role()
The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.static Class
<? extends CreatePipelineRequest.Builder> final PipelineOutputConfig
TheThumbnailConfig
object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
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.
- Returns:
- 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.
-
inputBucket
The Amazon S3 bucket in which you saved the media files that you want to transcode.
- Returns:
- The Amazon S3 bucket in which you saved the media files that you want to transcode.
-
outputBucket
The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)
Specify this value when all of the following are true:
-
You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
-
You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.
-
You do not want to specify the permissions that Elastic Transcoder grants to the files.
When Elastic Transcoder saves files in
OutputBucket
, it grants full control over the files only to the AWS account that owns the role that is specified byRole
. -
You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.
If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit
OutputBucket
and specify values forContentConfig
andThumbnailConfig
instead.- Returns:
- The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use
ContentConfig:Bucket plus ThumbnailConfig:Bucket.)
Specify this value when all of the following are true:
-
You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
-
You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.
-
You do not want to specify the permissions that Elastic Transcoder grants to the files.
When Elastic Transcoder saves files in
OutputBucket
, it grants full control over the files only to the AWS account that owns the role that is specified byRole
. -
You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.
If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit
OutputBucket
and specify values forContentConfig
andThumbnailConfig
instead. -
-
-
role
The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.
- Returns:
- The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.
-
awsKmsKeyArn
The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
If you use either
s3
ors3-aws-kms
as yourEncryption: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 anEncryption:Mode
ofaes-cbc-pkcs7
,aes-ctr
, oraes-gcm
.- Returns:
- The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
If you use either
s3
ors3-aws-kms
as yourEncryption: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 anEncryption:Mode
ofaes-cbc-pkcs7
,aes-ctr
, oraes-gcm
.
-
notifications
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: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.
-
Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
-
Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
-
Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
- Returns:
- 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: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.
-
Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
-
Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
-
Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
-
-
-
contentConfig
The optional
ContentConfig
object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.If you specify values for
ContentConfig
, you must also specify values forThumbnailConfig
.If you specify values for
ContentConfig
andThumbnailConfig
, omit theOutputBucket
object.-
Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.
-
Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.
-
Grantee Type: Specify the type of value that appears in the
Grantee
object:-
Canonical: The value in the
Grantee
object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content.A canonical user ID is not the same as an AWS account number.
-
Email: The value in the
Grantee
object is the registered email address of an AWS account. -
Group: The value in the
Grantee
object is one of the following predefined Amazon S3 groups:AllUsers
,AuthenticatedUsers
, orLogDelivery
.
-
-
Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group
-
Access: The permission that you want to give to the AWS user that you specified in
Grantee
. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. 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 hasREAD
,READ_ACP
, andWRITE_ACP
permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
-
-
StorageClass: The Amazon S3 storage class,
Standard
orReducedRedundancy
, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.
- Returns:
- The optional
ContentConfig
object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.If you specify values for
ContentConfig
, you must also specify values forThumbnailConfig
.If you specify values for
ContentConfig
andThumbnailConfig
, omit theOutputBucket
object.-
Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.
-
Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.
-
Grantee Type: Specify the type of value that appears in the
Grantee
object:-
Canonical: The value in the
Grantee
object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content.A canonical user ID is not the same as an AWS account number.
-
Email: The value in the
Grantee
object is the registered email address of an AWS account. -
Group: The value in the
Grantee
object is one of the following predefined Amazon S3 groups:AllUsers
,AuthenticatedUsers
, orLogDelivery
.
-
-
Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group
-
Access: The permission that you want to give to the AWS user that you specified in
Grantee
. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. 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 hasREAD
,READ_ACP
, andWRITE_ACP
permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
-
-
StorageClass: The Amazon S3 storage class,
Standard
orReducedRedundancy
, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.
-
-
-
thumbnailConfig
The
ThumbnailConfig
object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.If you specify values for
ContentConfig
, you must also specify values forThumbnailConfig
even if you don't want to create thumbnails.If you specify values for
ContentConfig
andThumbnailConfig
, omit theOutputBucket
object.-
Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.
-
Permissions (Optional): The
Permissions
object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups. -
GranteeType: Specify the type of value that appears in the Grantee object:
-
Canonical: The value in the
Grantee
object is 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 value in the
Grantee
object is the registered email address of an AWS account. -
Group: The value in the
Grantee
object is one of the following predefined Amazon S3 groups:AllUsers
,AuthenticatedUsers
, orLogDelivery
.
-
-
Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.
-
Access: The permission that you want to give to the AWS user that you specified in
Grantee
. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include:-
READ
: The grantee can read the thumbnails and metadata for objects 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 hasREAD
,READ_ACP
, andWRITE_ACP
permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
-
-
StorageClass: The Amazon S3 storage class,
Standard
orReducedRedundancy
, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.
- Returns:
- The
ThumbnailConfig
object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.If you specify values for
ContentConfig
, you must also specify values forThumbnailConfig
even if you don't want to create thumbnails.If you specify values for
ContentConfig
andThumbnailConfig
, omit theOutputBucket
object.-
Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.
-
Permissions (Optional): The
Permissions
object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups. -
GranteeType: Specify the type of value that appears in the Grantee object:
-
Canonical: The value in the
Grantee
object is 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 value in the
Grantee
object is the registered email address of an AWS account. -
Group: The value in the
Grantee
object is one of the following predefined Amazon S3 groups:AllUsers
,AuthenticatedUsers
, orLogDelivery
.
-
-
Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.
-
Access: The permission that you want to give to the AWS user that you specified in
Grantee
. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include:-
READ
: The grantee can read the thumbnails and metadata for objects 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 hasREAD
,READ_ACP
, andWRITE_ACP
permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
-
-
StorageClass: The Amazon S3 storage class,
Standard
orReducedRedundancy
, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.
-
-
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreatePipelineRequest.Builder,
CreatePipelineRequest> - Specified by:
toBuilder
in classElasticTranscoderRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-