You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::MediaConnect::Types::GrantEntitlementRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GrantEntitlementRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  data_transfer_subscriber_fee_percent: 1,
  description: "__string",
  encryption: {
    algorithm: "aes128", # required, accepts aes128, aes192, aes256
    constant_initialization_vector: "__string",
    device_id: "__string",
    key_type: "speke", # accepts speke, static-key
    region: "__string",
    resource_id: "__string",
    role_arn: "__string", # required
    secret_arn: "__string",
    url: "__string",
  },
  entitlement_status: "ENABLED", # accepts ENABLED, DISABLED
  name: "__string",
  subscribers: ["__string"], # required
}

The entitlements that you want to grant on a flow.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#data_transfer_subscriber_fee_percent ⇒ Integer

Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

Returns:

  • (Integer) —

    Percentage from 0-100 of the data transfer cost to be billed to the subscriber.

#description ⇒ String

A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.

Returns:

  • (String) —

    A description of the entitlement.

#encryption ⇒ Types::Encryption

The type of encryption that will be used on the output that is associated with this entitlement.

Returns:

  • (Types::Encryption) —

    The type of encryption that will be used on the output that is associated with this entitlement.

#entitlement_status ⇒ String

An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.

Possible values:

  • ENABLED
  • DISABLED

Returns:

  • (String) —

    An indication of whether the new entitlement should be enabled or disabled as soon as it is created.

#name ⇒ String

The name of the entitlement. This value must be unique within the current flow.

Returns:

  • (String) —

    The name of the entitlement.

#subscribers ⇒ Array<String>

The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source.

Returns:

  • (Array<String>) —

    The AWS account IDs that you want to share your content with.