We recommend new projects start with resources from the AWS provider.
aws-native.ivs.IngestConfiguration
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::IVS::IngestConfiguration
Create IngestConfiguration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IngestConfiguration(name: string, args?: IngestConfigurationArgs, opts?: CustomResourceOptions);@overload
def IngestConfiguration(resource_name: str,
                        args: Optional[IngestConfigurationArgs] = None,
                        opts: Optional[ResourceOptions] = None)
@overload
def IngestConfiguration(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        ingest_protocol: Optional[IngestConfigurationIngestProtocol] = None,
                        insecure_ingest: Optional[bool] = None,
                        name: Optional[str] = None,
                        stage_arn: Optional[str] = None,
                        tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                        user_id: Optional[str] = None)func NewIngestConfiguration(ctx *Context, name string, args *IngestConfigurationArgs, opts ...ResourceOption) (*IngestConfiguration, error)public IngestConfiguration(string name, IngestConfigurationArgs? args = null, CustomResourceOptions? opts = null)
public IngestConfiguration(String name, IngestConfigurationArgs args)
public IngestConfiguration(String name, IngestConfigurationArgs args, CustomResourceOptions options)
type: aws-native:ivs:IngestConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args IngestConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args IngestConfigurationArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args IngestConfigurationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IngestConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IngestConfigurationArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
IngestConfiguration Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The IngestConfiguration resource accepts the following input properties:
- IngestProtocol Pulumi.Aws Native. Ivs. Ingest Configuration Ingest Protocol 
- Ingest Protocol.
- InsecureIngest bool
- Whether ingest configuration allows insecure ingest.
- Name string
- IngestConfiguration
- StageArn string
- Stage ARN. A value other than an empty string indicates that stage is linked to IngestConfiguration. Default: "" (recording is disabled).
- 
List<Pulumi.Aws Native. Inputs. Tag> 
- A list of key-value pairs that contain metadata for the asset model.
- UserId string
- User defined indentifier for participant associated with IngestConfiguration.
- IngestProtocol IngestConfiguration Ingest Protocol 
- Ingest Protocol.
- InsecureIngest bool
- Whether ingest configuration allows insecure ingest.
- Name string
- IngestConfiguration
- StageArn string
- Stage ARN. A value other than an empty string indicates that stage is linked to IngestConfiguration. Default: "" (recording is disabled).
- 
TagArgs 
- A list of key-value pairs that contain metadata for the asset model.
- UserId string
- User defined indentifier for participant associated with IngestConfiguration.
- ingestProtocol IngestConfiguration Ingest Protocol 
- Ingest Protocol.
- insecureIngest Boolean
- Whether ingest configuration allows insecure ingest.
- name String
- IngestConfiguration
- stageArn String
- Stage ARN. A value other than an empty string indicates that stage is linked to IngestConfiguration. Default: "" (recording is disabled).
- List<Tag>
- A list of key-value pairs that contain metadata for the asset model.
- userId String
- User defined indentifier for participant associated with IngestConfiguration.
- ingestProtocol IngestConfiguration Ingest Protocol 
- Ingest Protocol.
- insecureIngest boolean
- Whether ingest configuration allows insecure ingest.
- name string
- IngestConfiguration
- stageArn string
- Stage ARN. A value other than an empty string indicates that stage is linked to IngestConfiguration. Default: "" (recording is disabled).
- Tag[]
- A list of key-value pairs that contain metadata for the asset model.
- userId string
- User defined indentifier for participant associated with IngestConfiguration.
- ingest_protocol IngestConfiguration Ingest Protocol 
- Ingest Protocol.
- insecure_ingest bool
- Whether ingest configuration allows insecure ingest.
- name str
- IngestConfiguration
- stage_arn str
- Stage ARN. A value other than an empty string indicates that stage is linked to IngestConfiguration. Default: "" (recording is disabled).
- 
Sequence[TagArgs] 
- A list of key-value pairs that contain metadata for the asset model.
- user_id str
- User defined indentifier for participant associated with IngestConfiguration.
- ingestProtocol "RTMP" | "RTMPS"
- Ingest Protocol.
- insecureIngest Boolean
- Whether ingest configuration allows insecure ingest.
- name String
- IngestConfiguration
- stageArn String
- Stage ARN. A value other than an empty string indicates that stage is linked to IngestConfiguration. Default: "" (recording is disabled).
- List<Property Map>
- A list of key-value pairs that contain metadata for the asset model.
- userId String
- User defined indentifier for participant associated with IngestConfiguration.
Outputs
All input properties are implicitly available as output properties. Additionally, the IngestConfiguration resource produces the following output properties:
- Arn string
- IngestConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
- Id string
- The provider-assigned unique ID for this managed resource.
- ParticipantId string
- Participant Id is automatically generated on creation and assigned.
- State
Pulumi.Aws Native. Ivs. Ingest Configuration State 
- State of IngestConfiguration which determines whether IngestConfiguration is in use or not.
- StreamKey string
- Stream-key value.
- Arn string
- IngestConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
- Id string
- The provider-assigned unique ID for this managed resource.
- ParticipantId string
- Participant Id is automatically generated on creation and assigned.
- State
IngestConfiguration State Enum 
- State of IngestConfiguration which determines whether IngestConfiguration is in use or not.
- StreamKey string
- Stream-key value.
- arn String
- IngestConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
- id String
- The provider-assigned unique ID for this managed resource.
- participantId String
- Participant Id is automatically generated on creation and assigned.
- state
IngestConfiguration State 
- State of IngestConfiguration which determines whether IngestConfiguration is in use or not.
- streamKey String
- Stream-key value.
- arn string
- IngestConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
- id string
- The provider-assigned unique ID for this managed resource.
- participantId string
- Participant Id is automatically generated on creation and assigned.
- state
IngestConfiguration State 
- State of IngestConfiguration which determines whether IngestConfiguration is in use or not.
- streamKey string
- Stream-key value.
- arn str
- IngestConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
- id str
- The provider-assigned unique ID for this managed resource.
- participant_id str
- Participant Id is automatically generated on creation and assigned.
- state
IngestConfiguration State 
- State of IngestConfiguration which determines whether IngestConfiguration is in use or not.
- stream_key str
- Stream-key value.
- arn String
- IngestConfiguration ARN is automatically generated on creation and assigned as the unique identifier.
- id String
- The provider-assigned unique ID for this managed resource.
- participantId String
- Participant Id is automatically generated on creation and assigned.
- state "ACTIVE" | "INACTIVE"
- State of IngestConfiguration which determines whether IngestConfiguration is in use or not.
- streamKey String
- Stream-key value.
Supporting Types
IngestConfigurationIngestProtocol, IngestConfigurationIngestProtocolArgs        
- Rtmp
- RTMP
- Rtmps
- RTMPS
- IngestConfiguration Ingest Protocol Rtmp 
- RTMP
- IngestConfiguration Ingest Protocol Rtmps 
- RTMPS
- Rtmp
- RTMP
- Rtmps
- RTMPS
- Rtmp
- RTMP
- Rtmps
- RTMPS
- RTMP
- RTMP
- RTMPS
- RTMPS
- "RTMP"
- RTMP
- "RTMPS"
- RTMPS
IngestConfigurationState, IngestConfigurationStateArgs      
- Active
- ACTIVE
- Inactive
- INACTIVE
- IngestConfiguration State Active 
- ACTIVE
- IngestConfiguration State Inactive 
- INACTIVE
- Active
- ACTIVE
- Inactive
- INACTIVE
- Active
- ACTIVE
- Inactive
- INACTIVE
- ACTIVE
- ACTIVE
- INACTIVE
- INACTIVE
- "ACTIVE"
- ACTIVE
- "INACTIVE"
- INACTIVE
Tag, TagArgs  
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.