CfnIngestConfigurationProps
- class aws_cdk.aws_ivs.CfnIngestConfigurationProps(*, ingest_protocol=None, insecure_ingest=None, name=None, stage_arn=None, tags=None, user_id=None)
Bases:
object
Properties for defining a
CfnIngestConfiguration
.- Parameters:
ingest_protocol (
Optional
[str
]) – Type of ingest protocol that the user employs for broadcasting. Default: - “RTMPS”insecure_ingest (
Union
[bool
,IResolvable
,None
]) – Whether the channel allows insecure RTMP ingest. Default:false
. Default: - falsename (
Optional
[str
]) – Ingest name. Default: - “-”stage_arn (
Optional
[str
]) – ARN of the stage with which the IngestConfiguration is associated. Default: - “”tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – An array of key-value pairs to apply to this resource.user_id (
Optional
[str
]) – Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_ivs as ivs cfn_ingest_configuration_props = ivs.CfnIngestConfigurationProps( ingest_protocol="ingestProtocol", insecure_ingest=False, name="name", stage_arn="stageArn", tags=[CfnTag( key="key", value="value" )], user_id="userId" )
Attributes
- ingest_protocol
Type of ingest protocol that the user employs for broadcasting.
- insecure_ingest
Whether the channel allows insecure RTMP ingest.
Default:
false
.
- name
Ingest name.
- stage_arn
ARN of the stage with which the IngestConfiguration is associated.
- tags
An array of key-value pairs to apply to this resource.
- user_id
Customer-assigned name to help identify the participant using the IngestConfiguration;
this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.