AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb

Overview

Note:

When making an API call, you may pass GrantEntitlementRequest data as a hash:

{
  data_transfer_subscriber_fee_percent: 1,
  description: "__string",
  encryption: {
    algorithm: "aes128", # accepts aes128, aes192, aes256
    constant_initialization_vector: "__string",
    device_id: "__string",
    key_type: "speke", # accepts speke, static-key, srt-password
    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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_transfer_subscriber_fee_percentInteger

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

Returns:

  • (Integer)


1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 1569

class GrantEntitlementRequest < Struct.new(
  :data_transfer_subscriber_fee_percent,
  :description,
  :encryption,
  :entitlement_status,
  :name,
  :subscribers)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

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)


1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 1569

class GrantEntitlementRequest < Struct.new(
  :data_transfer_subscriber_fee_percent,
  :description,
  :encryption,
  :entitlement_status,
  :name,
  :subscribers)
  SENSITIVE = []
  include Aws::Structure
end

#encryptionTypes::Encryption

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

Returns:



1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 1569

class GrantEntitlementRequest < Struct.new(
  :data_transfer_subscriber_fee_percent,
  :description,
  :encryption,
  :entitlement_status,
  :name,
  :subscribers)
  SENSITIVE = []
  include Aws::Structure
end

#entitlement_statusString

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.

Returns:

  • (String)


1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 1569

class GrantEntitlementRequest < Struct.new(
  :data_transfer_subscriber_fee_percent,
  :description,
  :encryption,
  :entitlement_status,
  :name,
  :subscribers)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 1569

class GrantEntitlementRequest < Struct.new(
  :data_transfer_subscriber_fee_percent,
  :description,
  :encryption,
  :entitlement_status,
  :name,
  :subscribers)
  SENSITIVE = []
  include Aws::Structure
end

#subscribersArray<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>)


1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
# File 'gems/aws-sdk-mediaconnect/lib/aws-sdk-mediaconnect/types.rb', line 1569

class GrantEntitlementRequest < Struct.new(
  :data_transfer_subscriber_fee_percent,
  :description,
  :encryption,
  :entitlement_status,
  :name,
  :subscribers)
  SENSITIVE = []
  include Aws::Structure
end