CfnInput
- class aws_cdk.aws_medialive.CfnInput(scope, id, *, destinations=None, input_devices=None, input_security_groups=None, media_connect_flows=None, name=None, role_arn=None, sources=None, srt_settings=None, tags=None, type=None, vpc=None)
Bases:
CfnResource
The AWS::MediaLive::Input resource is a MediaLive resource type that creates an input.
A MediaLive input holds information that describes how the MediaLive channel is connected to the upstream system that is providing the source content that is to be transcoded.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-medialive-input.html
- CloudformationResource:
AWS::MediaLive::Input
- 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_medialive as medialive # tags: Any cfn_input = medialive.CfnInput(self, "MyCfnInput", destinations=[medialive.CfnInput.InputDestinationRequestProperty( stream_name="streamName" )], input_devices=[medialive.CfnInput.InputDeviceSettingsProperty( id="id" )], input_security_groups=["inputSecurityGroups"], media_connect_flows=[medialive.CfnInput.MediaConnectFlowRequestProperty( flow_arn="flowArn" )], name="name", role_arn="roleArn", sources=[medialive.CfnInput.InputSourceRequestProperty( password_param="passwordParam", url="url", username="username" )], srt_settings=medialive.CfnInput.SrtSettingsRequestProperty( srt_caller_sources=[medialive.CfnInput.SrtCallerSourceRequestProperty( decryption=medialive.CfnInput.SrtCallerDecryptionRequestProperty( algorithm="algorithm", passphrase_secret_arn="passphraseSecretArn" ), minimum_latency=123, srt_listener_address="srtListenerAddress", srt_listener_port="srtListenerPort", stream_id="streamId" )] ), tags=tags, type="type", vpc=medialive.CfnInput.InputVpcRequestProperty( security_group_ids=["securityGroupIds"], subnet_ids=["subnetIds"] ) )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).destinations (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,InputDestinationRequestProperty
,Dict
[str
,Any
]]],None
]) – Settings that apply only if the input is a push type of input.input_devices (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,InputDeviceSettingsProperty
,Dict
[str
,Any
]]],None
]) – Settings that apply only if the input is an Elemental Link input.input_security_groups (
Optional
[Sequence
[str
]]) – The list of input security groups (referenced by IDs) to attach to the input if the input is a push type.media_connect_flows (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,MediaConnectFlowRequestProperty
,Dict
[str
,Any
]]],None
]) – Settings that apply only if the input is a MediaConnect input.name (
Optional
[str
]) – A name for the input.role_arn (
Optional
[str
]) – The IAM role for MediaLive to assume when creating a MediaConnect input or Amazon VPC input. This doesn’t apply to other types of inputs. The role is identified by its ARN.sources (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,InputSourceRequestProperty
,Dict
[str
,Any
]]],None
]) – Settings that apply only if the input is a pull type of input.srt_settings (
Union
[IResolvable
,SrtSettingsRequestProperty
,Dict
[str
,Any
],None
]) –tags (
Any
) – A collection of tags for this input. Each tag is a key-value pair.type (
Optional
[str
]) – The type for this input.vpc (
Union
[IResolvable
,InputVpcRequestProperty
,Dict
[str
,Any
],None
]) – Settings that apply only if the input is an push input where the source is on Amazon VPC.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::MediaLive::Input'
- attr_arn
The ARN of the MediaLive input.
For example: arn:aws:medialive:us-west-1:111122223333:medialive:input:1234567. MediaLive creates this ARN when it creates the input.
- CloudformationAttribute:
Arn
- attr_destinations
For a push input, the the destination or destinations for the input.
The destinations are the URLs of locations on MediaLive where the upstream system pushes the content to, for this input. MediaLive creates these addresses when it creates the input.
- CloudformationAttribute:
Destinations
- attr_id
The unique ID for the device.
- CloudformationAttribute:
Id
- attr_sources
For a pull input, the source or sources for the input.
The sources are the URLs of locations on the upstream system where MediaLive pulls the content from, for this input. You included these URLs in the create request.
- CloudformationAttribute:
Sources
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- destinations
Settings that apply only if the input is a push type of input.
- input_devices
Settings that apply only if the input is an Elemental Link input.
- input_security_groups
The list of input security groups (referenced by IDs) to attach to the input if the input is a push type.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- media_connect_flows
Settings that apply only if the input is a MediaConnect input.
- name
A name for the input.
- node
The tree node.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- role_arn
The IAM role for MediaLive to assume when creating a MediaConnect input or Amazon VPC input.
- sources
Settings that apply only if the input is a pull type of input.
- srt_settings
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
Tag Manager which manages the tags for this resource.
- tags_raw
A collection of tags for this input.
- type
The type for this input.
- vpc
Settings that apply only if the input is an push input where the source is on Amazon VPC.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
InputDestinationRequestProperty
- class CfnInput.InputDestinationRequestProperty(*, stream_name=None)
Bases:
object
Settings that apply only if the input is a push type of input.
The parent of this entity is Input.
- Parameters:
stream_name (
Optional
[str
]) – The stream name (application name/application instance) for the location the RTMP source content will be pushed to in MediaLive.- 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_medialive as medialive input_destination_request_property = medialive.CfnInput.InputDestinationRequestProperty( stream_name="streamName" )
Attributes
- stream_name
The stream name (application name/application instance) for the location the RTMP source content will be pushed to in MediaLive.
InputDeviceRequestProperty
- class CfnInput.InputDeviceRequestProperty(*, id=None)
Bases:
object
- Parameters:
id (
Optional
[str
]) –- 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_medialive as medialive input_device_request_property = medialive.CfnInput.InputDeviceRequestProperty( id="id" )
Attributes
InputDeviceSettingsProperty
- class CfnInput.InputDeviceSettingsProperty(*, id=None)
Bases:
object
Settings that apply only if the input is an Elemental Link input.
The parent of this entity is Input.
- Parameters:
id (
Optional
[str
]) – The unique ID for the device.- 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_medialive as medialive input_device_settings_property = medialive.CfnInput.InputDeviceSettingsProperty( id="id" )
Attributes
InputSourceRequestProperty
- class CfnInput.InputSourceRequestProperty(*, password_param=None, url=None, username=None)
Bases:
object
Settings that apply only if the input is a pull type of input.
The parent of this entity is Input.
- Parameters:
password_param (
Optional
[str
]) – The password parameter that holds the password for accessing the upstream system. The password parameter applies only if the upstream system requires credentials.url (
Optional
[str
]) – For a pull input, the URL where MediaLive pulls the source content from.username (
Optional
[str
]) – The user name to connect to the upstream system. The user name applies only if the upstream system requires credentials.
- 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_medialive as medialive input_source_request_property = medialive.CfnInput.InputSourceRequestProperty( password_param="passwordParam", url="url", username="username" )
Attributes
- password_param
The password parameter that holds the password for accessing the upstream system.
The password parameter applies only if the upstream system requires credentials.
- url
For a pull input, the URL where MediaLive pulls the source content from.
- username
The user name to connect to the upstream system.
The user name applies only if the upstream system requires credentials.
InputVpcRequestProperty
- class CfnInput.InputVpcRequestProperty(*, security_group_ids=None, subnet_ids=None)
Bases:
object
Settings that apply only if the input is an push input where the source is on Amazon VPC.
The parent of this entity is Input.
- Parameters:
security_group_ids (
Optional
[Sequence
[str
]]) – The list of up to five VPC security group IDs to attach to the input VPC network interfaces. The security groups require subnet IDs. If none are specified, MediaLive uses the VPC default security group.subnet_ids (
Optional
[Sequence
[str
]]) – The list of two VPC subnet IDs from the same VPC. You must associate subnet IDs to two unique Availability Zones.
- 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_medialive as medialive input_vpc_request_property = medialive.CfnInput.InputVpcRequestProperty( security_group_ids=["securityGroupIds"], subnet_ids=["subnetIds"] )
Attributes
- security_group_ids
The list of up to five VPC security group IDs to attach to the input VPC network interfaces.
The security groups require subnet IDs. If none are specified, MediaLive uses the VPC default security group.
- subnet_ids
The list of two VPC subnet IDs from the same VPC.
You must associate subnet IDs to two unique Availability Zones.
MediaConnectFlowRequestProperty
- class CfnInput.MediaConnectFlowRequestProperty(*, flow_arn=None)
Bases:
object
Settings that apply only if the input is a MediaConnect input.
The parent of this entity is Input.
- Parameters:
flow_arn (
Optional
[str
]) – The ARN of one or two MediaConnect flows that are the sources for this MediaConnect input.- 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_medialive as medialive media_connect_flow_request_property = medialive.CfnInput.MediaConnectFlowRequestProperty( flow_arn="flowArn" )
Attributes
- flow_arn
The ARN of one or two MediaConnect flows that are the sources for this MediaConnect input.
SrtCallerDecryptionRequestProperty
- class CfnInput.SrtCallerDecryptionRequestProperty(*, algorithm=None, passphrase_secret_arn=None)
Bases:
object
- Parameters:
algorithm (
Optional
[str
]) –passphrase_secret_arn (
Optional
[str
]) –
- 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_medialive as medialive srt_caller_decryption_request_property = medialive.CfnInput.SrtCallerDecryptionRequestProperty( algorithm="algorithm", passphrase_secret_arn="passphraseSecretArn" )
Attributes
- algorithm
-
- Type:
see
SrtCallerSourceRequestProperty
- class CfnInput.SrtCallerSourceRequestProperty(*, decryption=None, minimum_latency=None, srt_listener_address=None, srt_listener_port=None, stream_id=None)
Bases:
object
- Parameters:
decryption (
Union
[IResolvable
,SrtCallerDecryptionRequestProperty
,Dict
[str
,Any
],None
]) –minimum_latency (
Union
[int
,float
,None
]) –srt_listener_address (
Optional
[str
]) –srt_listener_port (
Optional
[str
]) –stream_id (
Optional
[str
]) –
- 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_medialive as medialive srt_caller_source_request_property = medialive.CfnInput.SrtCallerSourceRequestProperty( decryption=medialive.CfnInput.SrtCallerDecryptionRequestProperty( algorithm="algorithm", passphrase_secret_arn="passphraseSecretArn" ), minimum_latency=123, srt_listener_address="srtListenerAddress", srt_listener_port="srtListenerPort", stream_id="streamId" )
Attributes
- decryption
-
- Type:
see
- minimum_latency
-
- Type:
see
- srt_listener_address
-
- Type:
see
- srt_listener_port
-
- Type:
see
SrtSettingsRequestProperty
- class CfnInput.SrtSettingsRequestProperty(*, srt_caller_sources=None)
Bases:
object
- Parameters:
srt_caller_sources (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,SrtCallerSourceRequestProperty
,Dict
[str
,Any
]]],None
]) –- 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_medialive as medialive srt_settings_request_property = medialive.CfnInput.SrtSettingsRequestProperty( srt_caller_sources=[medialive.CfnInput.SrtCallerSourceRequestProperty( decryption=medialive.CfnInput.SrtCallerDecryptionRequestProperty( algorithm="algorithm", passphrase_secret_arn="passphraseSecretArn" ), minimum_latency=123, srt_listener_address="srtListenerAddress", srt_listener_port="srtListenerPort", stream_id="streamId" )] )
Attributes