Class S3RoleBasedInput

S3RoleBasedInput

Inheritance

System.Object

BitmovinResponse

BitmovinResource

Input

S3RoleBasedInput

Inherited Members

BitmovinResource.Name

BitmovinResource.Description

BitmovinResource.CreatedAt

BitmovinResource.ModifiedAt

BitmovinResource.CustomData

BitmovinResponse.Id

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Bitmovin.Api.Sdk.Models

Assembly: Bitmovin.Api.Sdk.dll

Syntax

public class S3RoleBasedInput : Input

Properties

BucketName

Amazon S3 bucket name (required)

Declaration

public string BucketName { get; set; }

Property Value

Type	Description
System.String

CloudRegion

Declaration

public AwsCloudRegion? CloudRegion { get; set; }

Property Value

Type	Description
System.Nullable<AwsCloudRegion>

ExternalId

External ID used together with the IAM role identified by roleArn to assume S3 access. This ID is provided by the API if externalIdMode is set to GLOBAL or GENERATED. If present, it has to be added to the trust policy of the IAM role roleArn configured above, otherwise the API won't be able to read from the S3 bucket. An appropriate trust policy would look like this: { \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\" }, \"Action\": \"sts:AssumeRole\", \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"{{externalId}}\" } } } where "{{externalId}}" is the generated ID. This property is optional but we recommend it as an additional security feature. We will use both the roleArn and the externalId to access your S3 data. If the Amazon IAM role has an external ID configured but it is not provided in the input configuration Bitmovin won't be able to read from the S3 bucket. Also if the external ID does not match the one configured for the IAM role on AWS side, Bitmovin won't be able to access the S3 bucket. If you need to change the external ID that is used by your IAM role, you need to create a new input, and use the external ID provided by the API to update your IAM role. For more information please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html

Declaration

public string ExternalId { get; set; }

Property Value

Type	Description
System.String

ExternalIdMode

Declaration

public ExternalIdMode? ExternalIdMode { get; set; }

Property Value

Type	Description
System.Nullable<ExternalIdMode>

RoleArn

Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access. This role has to be created by the owner of the account with the S3 bucket (i.e., you as a customer). For Bitmovin to be able to assume this role, the following has to be added to the trust policy of the role: { \"Effect\": \"Allow\", \"Principal\": { \"AWS\": \"arn:aws:iam::630681592166:user/bitmovinCustomerS3Access\" }, \"Action\": \"sts:AssumeRole\", \"Condition\": { \"StringEquals\": { \"sts:ExternalId\": \"{{externalId}}\" } } } where "arn:aws:iam::630681592166:user/bitmovinCustomerS3Access" is the Bitmovin user used for the access. The Condition is optional but we highly recommend it, see property externalId below for more information. This setup allows Bitmovin assume the provided IAM role and to read data from your S3 bucket. Please note that the IAM role has to have read access on S3. For more information about role creation please visit https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html#roles-creatingrole-service-console (required)

Declaration

public string RoleArn { get; set; }

Property Value

Type	Description
System.String