/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.elastictranscoder.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** *

* The CreatePipelineRequest structure. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreatePipelineRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* 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. *

*/ private String name; /** *

* The Amazon S3 bucket in which you saved the media files that you want to transcode. *

*/ private String inputBucket; /** *

* 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: *

* *

* 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 for ContentConfig and ThumbnailConfig * instead. *

*/ private String outputBucket; /** *

* The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline. *

*/ private String role; /** *

* 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. *

*/ private String awsKmsKeyArn; /** *

* 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. *

* * */ private Notifications notifications; /** *

* 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 for * ThumbnailConfig. *

*

* If you specify values for ContentConfig and ThumbnailConfig, omit the * OutputBucket object. *

* */ private PipelineOutputConfig contentConfig; /** *

* 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 for * ThumbnailConfig even if you don't want to create thumbnails. *

*

* If you specify values for ContentConfig and ThumbnailConfig, omit the * OutputBucket object. *

* */ private PipelineOutputConfig thumbnailConfig; /** *

* 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. *

* * @param 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. */ public void setName(String name) { this.name = 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. *

* * @return 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. */ public String getName() { return this.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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreatePipelineRequest withName(String name) { setName(name); return this; } /** *

* The Amazon S3 bucket in which you saved the media files that you want to transcode. *

* * @param inputBucket * The Amazon S3 bucket in which you saved the media files that you want to transcode. */ public void setInputBucket(String inputBucket) { this.inputBucket = inputBucket; } /** *

* The Amazon S3 bucket in which you saved the media files that you want to transcode. *

* * @return The Amazon S3 bucket in which you saved the media files that you want to transcode. */ public String getInputBucket() { return this.inputBucket; } /** *

* The Amazon S3 bucket in which you saved the media files that you want to transcode. *

* * @param inputBucket * The Amazon S3 bucket in which you saved the media files that you want to transcode. * @return Returns a reference to this object so that method calls can be chained together. */ public CreatePipelineRequest withInputBucket(String inputBucket) { setInputBucket(inputBucket); return this; } /** *

* 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: *

* *

* 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 for ContentConfig and ThumbnailConfig * instead. *

* * @param 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: *

* *

* 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 for ContentConfig and * ThumbnailConfig instead. */ public void setOutputBucket(String outputBucket) { this.outputBucket = 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: *

* *

* 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 for ContentConfig and ThumbnailConfig * instead. *

* * @return 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: *

* *

* 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 for ContentConfig * and ThumbnailConfig instead. */ public String getOutputBucket() { return this.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: *

* *

* 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 for ContentConfig and ThumbnailConfig * instead. *

* * @param 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: *

* *

* 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 for ContentConfig and * ThumbnailConfig instead. * @return Returns a reference to this object so that method calls can be chained together. */ public CreatePipelineRequest withOutputBucket(String outputBucket) { setOutputBucket(outputBucket); return this; } /** *

* The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline. *

* * @param role * The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the * pipeline. */ public void setRole(String role) { this.role = role; } /** *

* The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline. *

* * @return The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the * pipeline. */ public String getRole() { return this.role; } /** *

* The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline. *

* * @param role * The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the * pipeline. * @return Returns a reference to this object so that method calls can be chained together. */ public CreatePipelineRequest withRole(String role) { setRole(role); return this; } /** *

* 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. *

* * @param awsKmsKeyArn * 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. */ public void setAwsKmsKeyArn(String awsKmsKeyArn) { this.awsKmsKeyArn = awsKmsKeyArn; } /** *

* 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. *

* * @return 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. */ public String getAwsKmsKeyArn() { return this.awsKmsKeyArn; } /** *

* 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. *

* * @param awsKmsKeyArn * 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreatePipelineRequest withAwsKmsKeyArn(String awsKmsKeyArn) { setAwsKmsKeyArn(awsKmsKeyArn); return this; } /** *

* 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. *

* * * * @param 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. *

* *