AWS SDK for C++  1.9.125
AWS SDK for C++
Public Member Functions | List of all members
Aws::MediaTailor::Model::AccessConfiguration Class Reference

#include <AccessConfiguration.h>

Public Member Functions

 AccessConfiguration ()
 
 AccessConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
AccessConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const AccessTypeGetAccessType () const
 
bool AccessTypeHasBeenSet () const
 
void SetAccessType (const AccessType &value)
 
void SetAccessType (AccessType &&value)
 
AccessConfigurationWithAccessType (const AccessType &value)
 
AccessConfigurationWithAccessType (AccessType &&value)
 
const SecretsManagerAccessTokenConfigurationGetSecretsManagerAccessTokenConfiguration () const
 
bool SecretsManagerAccessTokenConfigurationHasBeenSet () const
 
void SetSecretsManagerAccessTokenConfiguration (const SecretsManagerAccessTokenConfiguration &value)
 
void SetSecretsManagerAccessTokenConfiguration (SecretsManagerAccessTokenConfiguration &&value)
 
AccessConfigurationWithSecretsManagerAccessTokenConfiguration (const SecretsManagerAccessTokenConfiguration &value)
 
AccessConfigurationWithSecretsManagerAccessTokenConfiguration (SecretsManagerAccessTokenConfiguration &&value)
 

Detailed Description

Access configuration parameters.

See Also:

AWS API Reference

Definition at line 32 of file AccessConfiguration.h.

Constructor & Destructor Documentation

◆ AccessConfiguration() [1/2]

Aws::MediaTailor::Model::AccessConfiguration::AccessConfiguration ( )

◆ AccessConfiguration() [2/2]

Aws::MediaTailor::Model::AccessConfiguration::AccessConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AccessTypeHasBeenSet()

bool Aws::MediaTailor::Model::AccessConfiguration::AccessTypeHasBeenSet ( ) const
inline

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.

Definition at line 79 of file AccessConfiguration.h.

◆ GetAccessType()

const AccessType& Aws::MediaTailor::Model::AccessConfiguration::GetAccessType ( ) const
inline

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.

Definition at line 59 of file AccessConfiguration.h.

◆ GetSecretsManagerAccessTokenConfiguration()

const SecretsManagerAccessTokenConfiguration& Aws::MediaTailor::Model::AccessConfiguration::GetSecretsManagerAccessTokenConfiguration ( ) const
inline

AWS Secrets Manager access token configuration parameters.

Definition at line 165 of file AccessConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::MediaTailor::Model::AccessConfiguration::Jsonize ( ) const

◆ operator=()

AccessConfiguration& Aws::MediaTailor::Model::AccessConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SecretsManagerAccessTokenConfigurationHasBeenSet()

bool Aws::MediaTailor::Model::AccessConfiguration::SecretsManagerAccessTokenConfigurationHasBeenSet ( ) const
inline

AWS Secrets Manager access token configuration parameters.

Definition at line 170 of file AccessConfiguration.h.

◆ SetAccessType() [1/2]

void Aws::MediaTailor::Model::AccessConfiguration::SetAccessType ( AccessType &&  value)
inline

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.

Definition at line 119 of file AccessConfiguration.h.

◆ SetAccessType() [2/2]

void Aws::MediaTailor::Model::AccessConfiguration::SetAccessType ( const AccessType value)
inline

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.

Definition at line 99 of file AccessConfiguration.h.

◆ SetSecretsManagerAccessTokenConfiguration() [1/2]

void Aws::MediaTailor::Model::AccessConfiguration::SetSecretsManagerAccessTokenConfiguration ( const SecretsManagerAccessTokenConfiguration value)
inline

AWS Secrets Manager access token configuration parameters.

Definition at line 175 of file AccessConfiguration.h.

◆ SetSecretsManagerAccessTokenConfiguration() [2/2]

void Aws::MediaTailor::Model::AccessConfiguration::SetSecretsManagerAccessTokenConfiguration ( SecretsManagerAccessTokenConfiguration &&  value)
inline

AWS Secrets Manager access token configuration parameters.

Definition at line 180 of file AccessConfiguration.h.

◆ WithAccessType() [1/2]

AccessConfiguration& Aws::MediaTailor::Model::AccessConfiguration::WithAccessType ( AccessType &&  value)
inline

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.

Definition at line 159 of file AccessConfiguration.h.

◆ WithAccessType() [2/2]

AccessConfiguration& Aws::MediaTailor::Model::AccessConfiguration::WithAccessType ( const AccessType value)
inline

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.

Definition at line 139 of file AccessConfiguration.h.

◆ WithSecretsManagerAccessTokenConfiguration() [1/2]

AccessConfiguration& Aws::MediaTailor::Model::AccessConfiguration::WithSecretsManagerAccessTokenConfiguration ( const SecretsManagerAccessTokenConfiguration value)
inline

AWS Secrets Manager access token configuration parameters.

Definition at line 185 of file AccessConfiguration.h.

◆ WithSecretsManagerAccessTokenConfiguration() [2/2]

AccessConfiguration& Aws::MediaTailor::Model::AccessConfiguration::WithSecretsManagerAccessTokenConfiguration ( SecretsManagerAccessTokenConfiguration &&  value)
inline

AWS Secrets Manager access token configuration parameters.

Definition at line 190 of file AccessConfiguration.h.


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