« blib/lib/Paws/MediaConnect/AddOutputRequest.pm
↑ Summary
blib/lib/Paws/MediaConnect/CreateFlowResponse.pm »
| 1 | |||
| 2 | package Paws::MediaConnect::CreateFlow; | ||
| 3 | use Moose; | ||
| 4 | has AvailabilityZone => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'availabilityZone'); | ||
| 5 | has Entitlements => (is => 'ro', isa => 'ArrayRef[Paws::MediaConnect::GrantEntitlementRequest]', traits => ['NameInRequest'], request_name => 'entitlements'); | ||
| 6 | has MediaStreams => (is => 'ro', isa => 'ArrayRef[Paws::MediaConnect::AddMediaStreamRequest]', traits => ['NameInRequest'], request_name => 'mediaStreams'); | ||
| 7 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name', required => 1); | ||
| 8 | has Outputs => (is => 'ro', isa => 'ArrayRef[Paws::MediaConnect::AddOutputRequest]', traits => ['NameInRequest'], request_name => 'outputs'); | ||
| 9 | has Source => (is => 'ro', isa => 'Paws::MediaConnect::SetSourceRequest', traits => ['NameInRequest'], request_name => 'source'); | ||
| 10 | has SourceFailoverConfig => (is => 'ro', isa => 'Paws::MediaConnect::FailoverConfig', traits => ['NameInRequest'], request_name => 'sourceFailoverConfig'); | ||
| 11 | has Sources => (is => 'ro', isa => 'ArrayRef[Paws::MediaConnect::SetSourceRequest]', traits => ['NameInRequest'], request_name => 'sources'); | ||
| 12 | has VpcInterfaces => (is => 'ro', isa => 'ArrayRef[Paws::MediaConnect::VpcInterfaceRequest]', traits => ['NameInRequest'], request_name => 'vpcInterfaces'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateFlow'); | ||
| 17 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/flows'); | ||
| 18 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 19 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MediaConnect::CreateFlowResponse'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::MediaConnect::CreateFlow - Arguments for method CreateFlow on L<Paws::MediaConnect> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method CreateFlow on the | ||
| 31 | L<AWS MediaConnect|Paws::MediaConnect> service. Use the attributes of this class | ||
| 32 | as arguments to method CreateFlow. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFlow. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $mediaconnect = Paws->service('MediaConnect'); | ||
| 39 | my $CreateFlowResponse = $mediaconnect->CreateFlow( | ||
| 40 | Name => 'My__string', | ||
| 41 | AvailabilityZone => 'My__string', # OPTIONAL | ||
| 42 | Entitlements => [ | ||
| 43 | { | ||
| 44 | Subscribers => [ 'My__string', ... ], | ||
| 45 | DataTransferSubscriberFeePercent => 1, # OPTIONAL | ||
| 46 | Description => 'My__string', | ||
| 47 | Encryption => { | ||
| 48 | RoleArn => 'My__string', | ||
| 49 | Algorithm => 'aes128', # values: aes128, aes192, aes256; OPTIONAL | ||
| 50 | ConstantInitializationVector => 'My__string', | ||
| 51 | DeviceId => 'My__string', | ||
| 52 | KeyType => | ||
| 53 | 'speke', # values: speke, static-key, srt-password; OPTIONAL | ||
| 54 | Region => 'My__string', | ||
| 55 | ResourceId => 'My__string', | ||
| 56 | SecretArn => 'My__string', | ||
| 57 | Url => 'My__string', | ||
| 58 | }, # OPTIONAL | ||
| 59 | EntitlementStatus => 'ENABLED', # values: ENABLED, DISABLED; OPTIONAL | ||
| 60 | Name => 'My__string', | ||
| 61 | }, | ||
| 62 | ... | ||
| 63 | ], # OPTIONAL | ||
| 64 | MediaStreams => [ | ||
| 65 | { | ||
| 66 | MediaStreamId => 1, # OPTIONAL | ||
| 67 | MediaStreamName => 'My__string', | ||
| 68 | MediaStreamType => 'video', # values: video, audio, ancillary-data | ||
| 69 | Attributes => { | ||
| 70 | Fmtp => { | ||
| 71 | ChannelOrder => 'My__string', | ||
| 72 | Colorimetry => 'BT601' | ||
| 73 | , # values: BT601, BT709, BT2020, BT2100, ST2065-1, ST2065-3, XYZ; OPTIONAL | ||
| 74 | ExactFramerate => 'My__string', | ||
| 75 | Par => 'My__string', | ||
| 76 | Range => 'NARROW', # values: NARROW, FULL, FULLPROTECT; OPTIONAL | ||
| 77 | ScanMode => 'progressive' | ||
| 78 | , # values: progressive, interlace, progressive-segmented-frame; OPTIONAL | ||
| 79 | Tcs => 'SDR' | ||
| 80 | , # values: SDR, PQ, HLG, LINEAR, BT2100LINPQ, BT2100LINHLG, ST2065-1, ST428-1, DENSITY; OPTIONAL | ||
| 81 | }, # OPTIONAL | ||
| 82 | Lang => 'My__string', | ||
| 83 | }, # OPTIONAL | ||
| 84 | ClockRate => 1, # OPTIONAL | ||
| 85 | Description => 'My__string', | ||
| 86 | VideoFormat => 'My__string', | ||
| 87 | }, | ||
| 88 | ... | ||
| 89 | ], # OPTIONAL | ||
| 90 | Outputs => [ | ||
| 91 | { | ||
| 92 | Protocol => 'zixi-push' | ||
| 93 | , # values: zixi-push, rtp-fec, rtp, zixi-pull, rist, st2110-jpegxs, cdi, srt-listener | ||
| 94 | CidrAllowList => [ 'My__string', ... ], | ||
| 95 | Description => 'My__string', | ||
| 96 | Destination => 'My__string', | ||
| 97 | Encryption => { | ||
| 98 | RoleArn => 'My__string', | ||
| 99 | Algorithm => 'aes128', # values: aes128, aes192, aes256; OPTIONAL | ||
| 100 | ConstantInitializationVector => 'My__string', | ||
| 101 | DeviceId => 'My__string', | ||
| 102 | KeyType => | ||
| 103 | 'speke', # values: speke, static-key, srt-password; OPTIONAL | ||
| 104 | Region => 'My__string', | ||
| 105 | ResourceId => 'My__string', | ||
| 106 | SecretArn => 'My__string', | ||
| 107 | Url => 'My__string', | ||
| 108 | }, # OPTIONAL | ||
| 109 | MaxLatency => 1, # OPTIONAL | ||
| 110 | MediaStreamOutputConfigurations => [ | ||
| 111 | { | ||
| 112 | EncodingName => 'jxsv', # values: jxsv, raw, smpte291, pcm | ||
| 113 | MediaStreamName => 'My__string', | ||
| 114 | DestinationConfigurations => [ | ||
| 115 | { | ||
| 116 | DestinationIp => 'My__string', | ||
| 117 | DestinationPort => 1, # OPTIONAL | ||
| 118 | Interface => { | ||
| 119 | Name => 'My__string', | ||
| 120 | |||
| 121 | }, | ||
| 122 | |||
| 123 | }, | ||
| 124 | ... | ||
| 125 | ], # OPTIONAL | ||
| 126 | EncodingParameters => { | ||
| 127 | CompressionFactor => 1, | ||
| 128 | EncoderProfile => 'main', # values: main, high | ||
| 129 | |||
| 130 | }, # OPTIONAL | ||
| 131 | }, | ||
| 132 | ... | ||
| 133 | ], # OPTIONAL | ||
| 134 | MinLatency => 1, # OPTIONAL | ||
| 135 | Name => 'My__string', | ||
| 136 | Port => 1, # OPTIONAL | ||
| 137 | RemoteId => 'My__string', | ||
| 138 | SmoothingLatency => 1, # OPTIONAL | ||
| 139 | StreamId => 'My__string', | ||
| 140 | VpcInterfaceAttachment => { VpcInterfaceName => 'My__string', } | ||
| 141 | , # OPTIONAL | ||
| 142 | }, | ||
| 143 | ... | ||
| 144 | ], # OPTIONAL | ||
| 145 | Source => { | ||
| 146 | Decryption => { | ||
| 147 | RoleArn => 'My__string', | ||
| 148 | Algorithm => 'aes128', # values: aes128, aes192, aes256; OPTIONAL | ||
| 149 | ConstantInitializationVector => 'My__string', | ||
| 150 | DeviceId => 'My__string', | ||
| 151 | KeyType => | ||
| 152 | 'speke', # values: speke, static-key, srt-password; OPTIONAL | ||
| 153 | Region => 'My__string', | ||
| 154 | ResourceId => 'My__string', | ||
| 155 | SecretArn => 'My__string', | ||
| 156 | Url => 'My__string', | ||
| 157 | }, # OPTIONAL | ||
| 158 | Description => 'My__string', | ||
| 159 | EntitlementArn => 'My__string', | ||
| 160 | IngestPort => 1, # OPTIONAL | ||
| 161 | MaxBitrate => 1, # OPTIONAL | ||
| 162 | MaxLatency => 1, # OPTIONAL | ||
| 163 | MaxSyncBuffer => 1, # OPTIONAL | ||
| 164 | MediaStreamSourceConfigurations => [ | ||
| 165 | { | ||
| 166 | EncodingName => 'jxsv', # values: jxsv, raw, smpte291, pcm | ||
| 167 | MediaStreamName => 'My__string', | ||
| 168 | InputConfigurations => [ | ||
| 169 | { | ||
| 170 | InputPort => 1, # OPTIONAL | ||
| 171 | Interface => { | ||
| 172 | Name => 'My__string', | ||
| 173 | |||
| 174 | }, | ||
| 175 | |||
| 176 | }, | ||
| 177 | ... | ||
| 178 | ], # OPTIONAL | ||
| 179 | }, | ||
| 180 | ... | ||
| 181 | ], # OPTIONAL | ||
| 182 | MinLatency => 1, # OPTIONAL | ||
| 183 | Name => 'My__string', | ||
| 184 | Protocol => 'zixi-push' | ||
| 185 | , # values: zixi-push, rtp-fec, rtp, zixi-pull, rist, st2110-jpegxs, cdi, srt-listener | ||
| 186 | StreamId => 'My__string', | ||
| 187 | VpcInterfaceName => 'My__string', | ||
| 188 | WhitelistCidr => 'My__string', | ||
| 189 | }, # OPTIONAL | ||
| 190 | SourceFailoverConfig => { | ||
| 191 | FailoverMode => 'MERGE', # values: MERGE, FAILOVER; OPTIONAL | ||
| 192 | RecoveryWindow => 1, # OPTIONAL | ||
| 193 | SourcePriority => { PrimarySource => 'My__string', }, # OPTIONAL | ||
| 194 | State => 'ENABLED', # values: ENABLED, DISABLED; OPTIONAL | ||
| 195 | }, # OPTIONAL | ||
| 196 | Sources => [ | ||
| 197 | { | ||
| 198 | Decryption => { | ||
| 199 | RoleArn => 'My__string', | ||
| 200 | Algorithm => 'aes128', # values: aes128, aes192, aes256; OPTIONAL | ||
| 201 | ConstantInitializationVector => 'My__string', | ||
| 202 | DeviceId => 'My__string', | ||
| 203 | KeyType => | ||
| 204 | 'speke', # values: speke, static-key, srt-password; OPTIONAL | ||
| 205 | Region => 'My__string', | ||
| 206 | ResourceId => 'My__string', | ||
| 207 | SecretArn => 'My__string', | ||
| 208 | Url => 'My__string', | ||
| 209 | }, # OPTIONAL | ||
| 210 | Description => 'My__string', | ||
| 211 | EntitlementArn => 'My__string', | ||
| 212 | IngestPort => 1, # OPTIONAL | ||
| 213 | MaxBitrate => 1, # OPTIONAL | ||
| 214 | MaxLatency => 1, # OPTIONAL | ||
| 215 | MaxSyncBuffer => 1, # OPTIONAL | ||
| 216 | MediaStreamSourceConfigurations => [ | ||
| 217 | { | ||
| 218 | EncodingName => 'jxsv', # values: jxsv, raw, smpte291, pcm | ||
| 219 | MediaStreamName => 'My__string', | ||
| 220 | InputConfigurations => [ | ||
| 221 | { | ||
| 222 | InputPort => 1, # OPTIONAL | ||
| 223 | Interface => { | ||
| 224 | Name => 'My__string', | ||
| 225 | |||
| 226 | }, | ||
| 227 | |||
| 228 | }, | ||
| 229 | ... | ||
| 230 | ], # OPTIONAL | ||
| 231 | }, | ||
| 232 | ... | ||
| 233 | ], # OPTIONAL | ||
| 234 | MinLatency => 1, # OPTIONAL | ||
| 235 | Name => 'My__string', | ||
| 236 | Protocol => 'zixi-push' | ||
| 237 | , # values: zixi-push, rtp-fec, rtp, zixi-pull, rist, st2110-jpegxs, cdi, srt-listener | ||
| 238 | StreamId => 'My__string', | ||
| 239 | VpcInterfaceName => 'My__string', | ||
| 240 | WhitelistCidr => 'My__string', | ||
| 241 | }, | ||
| 242 | ... | ||
| 243 | ], # OPTIONAL | ||
| 244 | VpcInterfaces => [ | ||
| 245 | { | ||
| 246 | Name => 'My__string', | ||
| 247 | RoleArn => 'My__string', | ||
| 248 | SecurityGroupIds => [ 'My__string', ... ], | ||
| 249 | SubnetId => 'My__string', | ||
| 250 | NetworkInterfaceType => 'ena', # values: ena, efa; OPTIONAL | ||
| 251 | }, | ||
| 252 | ... | ||
| 253 | ], # OPTIONAL | ||
| 254 | ); | ||
| 255 | |||
| 256 | # Results: | ||
| 257 | my $Flow = $CreateFlowResponse->Flow; | ||
| 258 | |||
| 259 | # Returns a L<Paws::MediaConnect::CreateFlowResponse> object. | ||
| 260 | |||
| 261 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 262 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/mediaconnect/CreateFlow> | ||
| 263 | |||
| 264 | =head1 ATTRIBUTES | ||
| 265 | |||
| 266 | |||
| 267 | =head2 AvailabilityZone => Str | ||
| 268 | |||
| 269 | The Availability Zone that you want to create the flow in. These | ||
| 270 | options are limited to the Availability Zones within the current AWS | ||
| 271 | Region. | ||
| 272 | |||
| 273 | |||
| 274 | |||
| 275 | =head2 Entitlements => ArrayRef[L<Paws::MediaConnect::GrantEntitlementRequest>] | ||
| 276 | |||
| 277 | The entitlements that you want to grant on a flow. | ||
| 278 | |||
| 279 | |||
| 280 | |||
| 281 | =head2 MediaStreams => ArrayRef[L<Paws::MediaConnect::AddMediaStreamRequest>] | ||
| 282 | |||
| 283 | The media streams that you want to add to the flow. You can associate | ||
| 284 | these media streams with sources and outputs on the flow. | ||
| 285 | |||
| 286 | |||
| 287 | |||
| 288 | =head2 B<REQUIRED> Name => Str | ||
| 289 | |||
| 290 | The name of the flow. | ||
| 291 | |||
| 292 | |||
| 293 | |||
| 294 | =head2 Outputs => ArrayRef[L<Paws::MediaConnect::AddOutputRequest>] | ||
| 295 | |||
| 296 | The outputs that you want to add to this flow. | ||
| 297 | |||
| 298 | |||
| 299 | |||
| 300 | =head2 Source => L<Paws::MediaConnect::SetSourceRequest> | ||
| 301 | |||
| 302 | |||
| 303 | |||
| 304 | |||
| 305 | |||
| 306 | =head2 SourceFailoverConfig => L<Paws::MediaConnect::FailoverConfig> | ||
| 307 | |||
| 308 | |||
| 309 | |||
| 310 | |||
| 311 | |||
| 312 | =head2 Sources => ArrayRef[L<Paws::MediaConnect::SetSourceRequest>] | ||
| 313 | |||
| 314 | |||
| 315 | |||
| 316 | |||
| 317 | |||
| 318 | =head2 VpcInterfaces => ArrayRef[L<Paws::MediaConnect::VpcInterfaceRequest>] | ||
| 319 | |||
| 320 | The VPC interfaces you want on the flow. | ||
| 321 | |||
| 322 | |||
| 323 | |||
| 324 | |||
| 325 | =head1 SEE ALSO | ||
| 326 | |||
| 327 | This class forms part of L<Paws>, documenting arguments for method CreateFlow in L<Paws::MediaConnect> | ||
| 328 | |||
| 329 | =head1 BUGS and CONTRIBUTIONS | ||
| 330 | |||
| 331 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 332 | |||
| 333 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 334 | |||
| 335 | =cut | ||
| 336 |