software.amazon.awssdk.services.mediatailor.model

Interface AccessConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AccessConfiguration.Builder,AccessConfiguration>, SdkBuilder<AccessConfiguration.Builder,AccessConfiguration>, SdkPojo

Enclosing class:

AccessConfiguration

public static interface AccessConfiguration.Builder
extends SdkPojo, CopyableBuilder<AccessConfiguration.Builder,AccessConfiguration>

Method Summary

Modifier and Type	Method and Description
AccessConfiguration.Builder	accessType(AccessType accessType) The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location.
AccessConfiguration.Builder	accessType(String accessType) The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location.
default AccessConfiguration.Builder	secretsManagerAccessTokenConfiguration(Consumer<SecretsManagerAccessTokenConfiguration.Builder> secretsManagerAccessTokenConfiguration) AWS Secrets Manager access token configuration parameters.
AccessConfiguration.Builder	secretsManagerAccessTokenConfiguration(SecretsManagerAccessTokenConfiguration secretsManagerAccessTokenConfiguration) AWS Secrets Manager access token configuration parameters.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

accessType

AccessConfiguration.Builder accessType(String accessType)

The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.

S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.

Before you can use S3_SIGV4, you must meet these requirements:

• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.

• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.

• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.

Parameters:

accessType - The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.

S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.

Before you can use S3_SIGV4, you must meet these requirements:

• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.

• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.

• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.

Returns:

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

See Also:

AccessType, AccessType

accessType

AccessConfiguration.Builder accessType(AccessType accessType)

The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.

S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.

Before you can use S3_SIGV4, you must meet these requirements:

• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.

• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.

• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.

Parameters:

accessType - The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.

S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.

Before you can use S3_SIGV4, you must meet these requirements:

• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.

• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.

• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.

Returns:

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

See Also:

AccessType, AccessType

secretsManagerAccessTokenConfiguration

AccessConfiguration.Builder secretsManagerAccessTokenConfiguration(SecretsManagerAccessTokenConfiguration secretsManagerAccessTokenConfiguration)

AWS Secrets Manager access token configuration parameters.

Parameters:

secretsManagerAccessTokenConfiguration - AWS Secrets Manager access token configuration parameters.

Returns:

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

secretsManagerAccessTokenConfiguration

default AccessConfiguration.Builder secretsManagerAccessTokenConfiguration(Consumer<SecretsManagerAccessTokenConfiguration.Builder> secretsManagerAccessTokenConfiguration)

AWS Secrets Manager access token configuration parameters.

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

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

Parameters:

secretsManagerAccessTokenConfiguration - a consumer that will call methods on SecretsManagerAccessTokenConfiguration.Builder

Returns:

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

See Also:

secretsManagerAccessTokenConfiguration(SecretsManagerAccessTokenConfiguration)