IngestConfigurationSummary
Summary information about an IngestConfiguration.
Contents
- arn
-
Ingest configuration ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
arn:aws:ivs:[a-z0-9-]+:[0-9]+:ingest-configuration/[a-zA-Z0-9-]+Required: Yes
- ingestProtocol
-
Type of ingest protocol that the user employs for broadcasting.
Type: String
Valid Values:
RTMP | RTMPSRequired: Yes
- participantId
-
ID of the participant within the stage.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 64.
Pattern:
[a-zA-Z0-9-]*Required: Yes
- stageArn
-
ARN of the stage with which the IngestConfiguration is associated.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern:
^$|^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$Required: Yes
- state
-
State of the ingest configuration. It is
ACTIVEif a publisher currently is publishing to the stage associated with the ingest configuration.Type: String
Valid Values:
ACTIVE | INACTIVERequired: Yes
- name
-
Ingest name.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Pattern:
[a-zA-Z0-9-_]*Required: No
- userId
-
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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
