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

Class: Aws::MediaConvert::Types::OutputGroupSettings

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

Overview

Note:

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

{
  cmaf_group_settings: {
    base_url: "__string",
    client_cache: "DISABLED", # accepts DISABLED, ENABLED
    codec_specification: "RFC_6381", # accepts RFC_6381, RFC_4281
    destination: "__stringPatternS3",
    destination_settings: {
      s3_settings: {
        encryption: {
          encryption_type: "SERVER_SIDE_ENCRYPTION_S3", # accepts SERVER_SIDE_ENCRYPTION_S3, SERVER_SIDE_ENCRYPTION_KMS
          kms_key_arn: "__stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912",
        },
      },
    },
    encryption: {
      constant_initialization_vector: "__stringMin32Max32Pattern09aFAF32",
      encryption_method: "SAMPLE_AES", # accepts SAMPLE_AES, AES_CTR
      initialization_vector_in_manifest: "INCLUDE", # accepts INCLUDE, EXCLUDE
      speke_key_provider: {
        certificate_arn: "__stringPatternArnAwsUsGovAcm",
        dash_signaled_system_ids: ["__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12"],
        hls_signaled_system_ids: ["__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12"],
        resource_id: "__stringPatternW",
        url: "__stringPatternHttps",
      },
      static_key_provider: {
        key_format: "__stringPatternIdentityAZaZ26AZaZ09163",
        key_format_versions: "__stringPatternDD",
        static_key_value: "__stringPatternAZaZ0932",
        url: "__string",
      },
      type: "SPEKE", # accepts SPEKE, STATIC_KEY
    },
    fragment_length: 1,
    manifest_compression: "GZIP", # accepts GZIP, NONE
    manifest_duration_format: "FLOATING_POINT", # accepts FLOATING_POINT, INTEGER
    min_buffer_time: 1,
    min_final_segment_length: 1.0,
    segment_control: "SINGLE_FILE", # accepts SINGLE_FILE, SEGMENTED_FILES
    segment_length: 1,
    stream_inf_resolution: "INCLUDE", # accepts INCLUDE, EXCLUDE
    write_dash_manifest: "DISABLED", # accepts DISABLED, ENABLED
    write_hls_manifest: "DISABLED", # accepts DISABLED, ENABLED
  },
  dash_iso_group_settings: {
    base_url: "__string",
    destination: "__stringPatternS3",
    destination_settings: {
      s3_settings: {
        encryption: {
          encryption_type: "SERVER_SIDE_ENCRYPTION_S3", # accepts SERVER_SIDE_ENCRYPTION_S3, SERVER_SIDE_ENCRYPTION_KMS
          kms_key_arn: "__stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912",
        },
      },
    },
    encryption: {
      playback_device_compatibility: "CENC_V1", # accepts CENC_V1, UNENCRYPTED_SEI
      speke_key_provider: {
        certificate_arn: "__stringPatternArnAwsUsGovAcm",
        resource_id: "__string",
        system_ids: ["__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12"],
        url: "__stringPatternHttps",
      },
    },
    fragment_length: 1,
    hbbtv_compliance: "HBBTV_1_5", # accepts HBBTV_1_5, NONE
    min_buffer_time: 1,
    segment_control: "SINGLE_FILE", # accepts SINGLE_FILE, SEGMENTED_FILES
    segment_length: 1,
    write_segment_timeline_in_representation: "ENABLED", # accepts ENABLED, DISABLED
  },
  file_group_settings: {
    destination: "__stringPatternS3",
    destination_settings: {
      s3_settings: {
        encryption: {
          encryption_type: "SERVER_SIDE_ENCRYPTION_S3", # accepts SERVER_SIDE_ENCRYPTION_S3, SERVER_SIDE_ENCRYPTION_KMS
          kms_key_arn: "__stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912",
        },
      },
    },
  },
  hls_group_settings: {
    ad_markers: ["ELEMENTAL"], # accepts ELEMENTAL, ELEMENTAL_SCTE35
    base_url: "__string",
    caption_language_mappings: [
      {
        caption_channel: 1,
        custom_language_code: "__stringMin3Max3PatternAZaZ3",
        language_code: "ENG", # accepts ENG, SPA, FRA, DEU, GER, ZHO, ARA, HIN, JPN, RUS, POR, ITA, URD, VIE, KOR, PAN, ABK, AAR, AFR, AKA, SQI, AMH, ARG, HYE, ASM, AVA, AVE, AYM, AZE, BAM, BAK, EUS, BEL, BEN, BIH, BIS, BOS, BRE, BUL, MYA, CAT, KHM, CHA, CHE, NYA, CHU, CHV, COR, COS, CRE, HRV, CES, DAN, DIV, NLD, DZO, ENM, EPO, EST, EWE, FAO, FIJ, FIN, FRM, FUL, GLA, GLG, LUG, KAT, ELL, GRN, GUJ, HAT, HAU, HEB, HER, HMO, HUN, ISL, IDO, IBO, IND, INA, ILE, IKU, IPK, GLE, JAV, KAL, KAN, KAU, KAS, KAZ, KIK, KIN, KIR, KOM, KON, KUA, KUR, LAO, LAT, LAV, LIM, LIN, LIT, LUB, LTZ, MKD, MLG, MSA, MAL, MLT, GLV, MRI, MAR, MAH, MON, NAU, NAV, NDE, NBL, NDO, NEP, SME, NOR, NOB, NNO, OCI, OJI, ORI, ORM, OSS, PLI, FAS, POL, PUS, QUE, QAA, RON, ROH, RUN, SMO, SAG, SAN, SRD, SRB, SNA, III, SND, SIN, SLK, SLV, SOM, SOT, SUN, SWA, SSW, SWE, TGL, TAH, TGK, TAM, TAT, TEL, THA, BOD, TIR, TON, TSO, TSN, TUR, TUK, TWI, UIG, UKR, UZB, VEN, VOL, WLN, CYM, FRY, WOL, XHO, YID, YOR, ZHA, ZUL, ORJ, QPC, TNG
        language_description: "__string",
      },
    ],
    caption_language_setting: "INSERT", # accepts INSERT, OMIT, NONE
    client_cache: "DISABLED", # accepts DISABLED, ENABLED
    codec_specification: "RFC_6381", # accepts RFC_6381, RFC_4281
    destination: "__stringPatternS3",
    destination_settings: {
      s3_settings: {
        encryption: {
          encryption_type: "SERVER_SIDE_ENCRYPTION_S3", # accepts SERVER_SIDE_ENCRYPTION_S3, SERVER_SIDE_ENCRYPTION_KMS
          kms_key_arn: "__stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912",
        },
      },
    },
    directory_structure: "SINGLE_DIRECTORY", # accepts SINGLE_DIRECTORY, SUBDIRECTORY_PER_STREAM
    encryption: {
      constant_initialization_vector: "__stringMin32Max32Pattern09aFAF32",
      encryption_method: "AES128", # accepts AES128, SAMPLE_AES
      initialization_vector_in_manifest: "INCLUDE", # accepts INCLUDE, EXCLUDE
      offline_encrypted: "ENABLED", # accepts ENABLED, DISABLED
      speke_key_provider: {
        certificate_arn: "__stringPatternArnAwsUsGovAcm",
        resource_id: "__string",
        system_ids: ["__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12"],
        url: "__stringPatternHttps",
      },
      static_key_provider: {
        key_format: "__stringPatternIdentityAZaZ26AZaZ09163",
        key_format_versions: "__stringPatternDD",
        static_key_value: "__stringPatternAZaZ0932",
        url: "__string",
      },
      type: "SPEKE", # accepts SPEKE, STATIC_KEY
    },
    manifest_compression: "GZIP", # accepts GZIP, NONE
    manifest_duration_format: "FLOATING_POINT", # accepts FLOATING_POINT, INTEGER
    min_final_segment_length: 1.0,
    min_segment_length: 1,
    output_selection: "MANIFESTS_AND_SEGMENTS", # accepts MANIFESTS_AND_SEGMENTS, SEGMENTS_ONLY
    program_date_time: "INCLUDE", # accepts INCLUDE, EXCLUDE
    program_date_time_period: 1,
    segment_control: "SINGLE_FILE", # accepts SINGLE_FILE, SEGMENTED_FILES
    segment_length: 1,
    segments_per_subdirectory: 1,
    stream_inf_resolution: "INCLUDE", # accepts INCLUDE, EXCLUDE
    timed_metadata_id_3_frame: "NONE", # accepts NONE, PRIV, TDRL
    timed_metadata_id_3_period: 1,
    timestamp_delta_milliseconds: 1,
  },
  ms_smooth_group_settings: {
    audio_deduplication: "COMBINE_DUPLICATE_STREAMS", # accepts COMBINE_DUPLICATE_STREAMS, NONE
    destination: "__stringPatternS3",
    destination_settings: {
      s3_settings: {
        encryption: {
          encryption_type: "SERVER_SIDE_ENCRYPTION_S3", # accepts SERVER_SIDE_ENCRYPTION_S3, SERVER_SIDE_ENCRYPTION_KMS
          kms_key_arn: "__stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912",
        },
      },
    },
    encryption: {
      speke_key_provider: {
        certificate_arn: "__stringPatternArnAwsUsGovAcm",
        resource_id: "__string",
        system_ids: ["__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12"],
        url: "__stringPatternHttps",
      },
    },
    fragment_length: 1,
    manifest_encoding: "UTF8", # accepts UTF8, UTF16
  },
  type: "HLS_GROUP_SETTINGS", # accepts HLS_GROUP_SETTINGS, DASH_ISO_GROUP_SETTINGS, FILE_GROUP_SETTINGS, MS_SMOOTH_GROUP_SETTINGS, CMAF_GROUP_SETTINGS
}

Output Group settings, including type

Instance Attribute Summary collapse

Instance Attribute Details

#cmaf_group_settingsTypes::CmafGroupSettings

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to CMAF_GROUP_SETTINGS. Each output in a CMAF Output Group may only contain a single video, audio, or caption output.



13946
13947
13948
13949
13950
13951
13952
13953
13954
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 13946

class OutputGroupSettings < Struct.new(
  :cmaf_group_settings,
  :dash_iso_group_settings,
  :file_group_settings,
  :hls_group_settings,
  :ms_smooth_group_settings,
  :type)
  include Aws::Structure
end

#dash_iso_group_settingsTypes::DashIsoGroupSettings

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to DASH_ISO_GROUP_SETTINGS.



13946
13947
13948
13949
13950
13951
13952
13953
13954
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 13946

class OutputGroupSettings < Struct.new(
  :cmaf_group_settings,
  :dash_iso_group_settings,
  :file_group_settings,
  :hls_group_settings,
  :ms_smooth_group_settings,
  :type)
  include Aws::Structure
end

#file_group_settingsTypes::FileGroupSettings

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to FILE_GROUP_SETTINGS.



13946
13947
13948
13949
13950
13951
13952
13953
13954
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 13946

class OutputGroupSettings < Struct.new(
  :cmaf_group_settings,
  :dash_iso_group_settings,
  :file_group_settings,
  :hls_group_settings,
  :ms_smooth_group_settings,
  :type)
  include Aws::Structure
end

#hls_group_settingsTypes::HlsGroupSettings

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to HLS_GROUP_SETTINGS.



13946
13947
13948
13949
13950
13951
13952
13953
13954
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 13946

class OutputGroupSettings < Struct.new(
  :cmaf_group_settings,
  :dash_iso_group_settings,
  :file_group_settings,
  :hls_group_settings,
  :ms_smooth_group_settings,
  :type)
  include Aws::Structure
end

#ms_smooth_group_settingsTypes::MsSmoothGroupSettings

Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to MS_SMOOTH_GROUP_SETTINGS.



13946
13947
13948
13949
13950
13951
13952
13953
13954
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 13946

class OutputGroupSettings < Struct.new(
  :cmaf_group_settings,
  :dash_iso_group_settings,
  :file_group_settings,
  :hls_group_settings,
  :ms_smooth_group_settings,
  :type)
  include Aws::Structure
end

#typeString

Type of output group (File group, Apple HLS, DASH ISO, Microsoft Smooth Streaming, CMAF)

Returns:

  • (String)


13946
13947
13948
13949
13950
13951
13952
13953
13954
# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 13946

class OutputGroupSettings < Struct.new(
  :cmaf_group_settings,
  :dash_iso_group_settings,
  :file_group_settings,
  :hls_group_settings,
  :ms_smooth_group_settings,
  :type)
  include Aws::Structure
end