Interface CreateMediaCapturePipelineRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ChimeSdkMediaPipelinesRequest.Builder, CopyableBuilder<CreateMediaCapturePipelineRequest.Builder,CreateMediaCapturePipelineRequest>, SdkBuilder<CreateMediaCapturePipelineRequest.Builder,CreateMediaCapturePipelineRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateMediaCapturePipelineRequest

@Mutable
@NotThreadSafe
public static interface CreateMediaCapturePipelineRequest.Builder
extends ChimeSdkMediaPipelinesRequest.Builder, SdkPojo, CopyableBuilder<CreateMediaCapturePipelineRequest.Builder,CreateMediaCapturePipelineRequest>

Method Summary

Modifier and Type	Method	Description
default CreateMediaCapturePipelineRequest.Builder	chimeSdkMeetingConfiguration(Consumer<ChimeSdkMeetingConfiguration.Builder> chimeSdkMeetingConfiguration)	The configuration for a specified media pipeline.
CreateMediaCapturePipelineRequest.Builder	chimeSdkMeetingConfiguration(ChimeSdkMeetingConfiguration chimeSdkMeetingConfiguration)	The configuration for a specified media pipeline.
CreateMediaCapturePipelineRequest.Builder	clientRequestToken(String clientRequestToken)	The unique identifier for the client request.
CreateMediaCapturePipelineRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateMediaCapturePipelineRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateMediaCapturePipelineRequest.Builder	sinkArn(String sinkArn)	The ARN of the sink type.
CreateMediaCapturePipelineRequest.Builder	sinkIamRoleArn(String sinkIamRoleArn)	The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId in SseAwsKeyManagementParams.
CreateMediaCapturePipelineRequest.Builder	sinkType(String sinkType)	Destination type to which the media artifacts are saved.
CreateMediaCapturePipelineRequest.Builder	sinkType(MediaPipelineSinkType sinkType)	Destination type to which the media artifacts are saved.
CreateMediaCapturePipelineRequest.Builder	sourceArn(String sourceArn)	ARN of the source from which the media artifacts are captured.
CreateMediaCapturePipelineRequest.Builder	sourceType(String sourceType)	Source type from which the media artifacts are captured.
CreateMediaCapturePipelineRequest.Builder	sourceType(MediaPipelineSourceType sourceType)	Source type from which the media artifacts are captured.
default CreateMediaCapturePipelineRequest.Builder	sseAwsKeyManagementParams(Consumer<SseAwsKeyManagementParams.Builder> sseAwsKeyManagementParams)	An object that contains server side encryption parameters to be used by media capture pipeline.
CreateMediaCapturePipelineRequest.Builder	sseAwsKeyManagementParams(SseAwsKeyManagementParams sseAwsKeyManagementParams)	An object that contains server side encryption parameters to be used by media capture pipeline.
CreateMediaCapturePipelineRequest.Builder	tags(Collection<Tag> tags)	The tag key-value pairs.
CreateMediaCapturePipelineRequest.Builder	tags(Consumer<Tag.Builder>... tags)	The tag key-value pairs.
CreateMediaCapturePipelineRequest.Builder	tags(Tag... tags)	The tag key-value pairs.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.chimesdkmediapipelines.model.ChimeSdkMediaPipelinesRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

sourceType

CreateMediaCapturePipelineRequest.Builder sourceType(String sourceType)

Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.

Parameters:

sourceType - Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• MediaPipelineSourceType
• MediaPipelineSourceType

sourceType

CreateMediaCapturePipelineRequest.Builder sourceType(MediaPipelineSourceType sourceType)

Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.

Parameters:

sourceType - Source type from which the media artifacts are captured. A Chime SDK Meeting is the only supported source.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• MediaPipelineSourceType
• MediaPipelineSourceType

sourceArn

CreateMediaCapturePipelineRequest.Builder sourceArn(String sourceArn)

ARN of the source from which the media artifacts are captured.

Parameters:

sourceArn - ARN of the source from which the media artifacts are captured.

Returns:

Returns a reference to this object so that method calls can be chained together.

sinkType

CreateMediaCapturePipelineRequest.Builder sinkType(String sinkType)

Destination type to which the media artifacts are saved. You must use an S3 bucket.

Parameters:

sinkType - Destination type to which the media artifacts are saved. You must use an S3 bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• MediaPipelineSinkType
• MediaPipelineSinkType

sinkType

CreateMediaCapturePipelineRequest.Builder sinkType(MediaPipelineSinkType sinkType)

Destination type to which the media artifacts are saved. You must use an S3 bucket.

Parameters:

sinkType - Destination type to which the media artifacts are saved. You must use an S3 bucket.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• MediaPipelineSinkType
• MediaPipelineSinkType

sinkArn

CreateMediaCapturePipelineRequest.Builder sinkArn(String sinkArn)

The ARN of the sink type.

Parameters:

sinkArn - The ARN of the sink type.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientRequestToken

CreateMediaCapturePipelineRequest.Builder clientRequestToken(String clientRequestToken)

The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.

Parameters:

clientRequestToken - The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.

Returns:

Returns a reference to this object so that method calls can be chained together.

chimeSdkMeetingConfiguration

CreateMediaCapturePipelineRequest.Builder chimeSdkMeetingConfiguration(ChimeSdkMeetingConfiguration chimeSdkMeetingConfiguration)

The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.

Parameters:

chimeSdkMeetingConfiguration - The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.

Returns:

Returns a reference to this object so that method calls can be chained together.

chimeSdkMeetingConfiguration

default CreateMediaCapturePipelineRequest.Builder chimeSdkMeetingConfiguration(Consumer<ChimeSdkMeetingConfiguration.Builder> chimeSdkMeetingConfiguration)

The configuration for a specified media pipeline. SourceType must be ChimeSdkMeeting.

This is a convenience method that creates an instance of the ChimeSdkMeetingConfiguration.Builder avoiding the need to create one manually via ChimeSdkMeetingConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to chimeSdkMeetingConfiguration(ChimeSdkMeetingConfiguration).

Parameters:

chimeSdkMeetingConfiguration - a consumer that will call methods on ChimeSdkMeetingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• chimeSdkMeetingConfiguration(ChimeSdkMeetingConfiguration)

sseAwsKeyManagementParams

CreateMediaCapturePipelineRequest.Builder sseAwsKeyManagementParams(SseAwsKeyManagementParams sseAwsKeyManagementParams)

An object that contains server side encryption parameters to be used by media capture pipeline. The parameters can also be used by media concatenation pipeline taking media capture pipeline as a media source.

Parameters:

sseAwsKeyManagementParams - An object that contains server side encryption parameters to be used by media capture pipeline. The parameters can also be used by media concatenation pipeline taking media capture pipeline as a media source.

Returns:

Returns a reference to this object so that method calls can be chained together.

sseAwsKeyManagementParams

default CreateMediaCapturePipelineRequest.Builder sseAwsKeyManagementParams(Consumer<SseAwsKeyManagementParams.Builder> sseAwsKeyManagementParams)

An object that contains server side encryption parameters to be used by media capture pipeline. The parameters can also be used by media concatenation pipeline taking media capture pipeline as a media source.

This is a convenience method that creates an instance of the SseAwsKeyManagementParams.Builder avoiding the need to create one manually via SseAwsKeyManagementParams.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sseAwsKeyManagementParams(SseAwsKeyManagementParams).

Parameters:

sseAwsKeyManagementParams - a consumer that will call methods on SseAwsKeyManagementParams.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• sseAwsKeyManagementParams(SseAwsKeyManagementParams)

sinkIamRoleArn

CreateMediaCapturePipelineRequest.Builder sinkIamRoleArn(String sinkIamRoleArn)

The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId in SseAwsKeyManagementParams. Can only interact with S3Bucket sink type. The role must belong to the caller’s account and be able to act on behalf of the caller during the API call. All minimum policy permissions requirements for the caller to perform sink-related actions are the same for SinkIamRoleArn.

Additionally, the role must have permission to kms:GenerateDataKey using KMS key supplied as AwsKmsKeyId in SseAwsKeyManagementParams. If media concatenation will be required later, the role must also have permission to kms:Decrypt for the same KMS key.

Parameters:

sinkIamRoleArn - The Amazon Resource Name (ARN) of the sink role to be used with AwsKmsKeyId in SseAwsKeyManagementParams. Can only interact with S3Bucket sink type. The role must belong to the caller’s account and be able to act on behalf of the caller during the API call. All minimum policy permissions requirements for the caller to perform sink-related actions are the same for SinkIamRoleArn.

Additionally, the role must have permission to kms:GenerateDataKey using KMS key supplied as AwsKmsKeyId in SseAwsKeyManagementParams. If media concatenation will be required later, the role must also have permission to kms:Decrypt for the same KMS key.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateMediaCapturePipelineRequest.Builder tags(Collection<Tag> tags)

The tag key-value pairs.

Parameters:

tags - The tag key-value pairs.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateMediaCapturePipelineRequest.Builder tags(Tag... tags)

The tag key-value pairs.

Parameters:

tags - The tag key-value pairs.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateMediaCapturePipelineRequest.Builder tags(Consumer<Tag.Builder>... tags)

The tag key-value pairs.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• tags(java.util.Collection<Tag>)

overrideConfiguration

CreateMediaCapturePipelineRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateMediaCapturePipelineRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.