Skip to content
v2.276.0

CfnSourceEndpointProps Struct Added in v2.276.0 ​

Properties for defining a CfnSourceEndpoint.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mediaconnect as mediaconnect } from 'aws-cdk-lib';
const cfnSourceEndpointProps: mediaconnect.CfnSourceEndpointProps = {
  configuration: {
    routerOutput: {
      routerOutputArn: 'routerOutputArn',
    },
    standard: {
      name: 'name',
      protocolConfiguration: {
        rist: {
          destinationIngestPort: 123,
          recoveryLatencyMilliseconds: 123,
        },
        rtp: {
          destinationIngestPort: 123,
          forwardErrorCorrectionState: 'forwardErrorCorrectionState',
        },
        srtCaller: {
          destinationIngestPort: 123,
          minimumLatencyMilliseconds: 123,

          // the properties below are optional
          encryptionPassphrase: {
            secretArn: 'secretArn',
          },
        },
        srtListener: {
          minimumLatencyMilliseconds: 123,
          sourceAddress: 'sourceAddress',
          sourceListenerPort: 123,

          // the properties below are optional
          encryptionPassphrase: {
            secretArn: 'secretArn',
          },
          streamId: 'streamId',
        },
      },
      sourceNetworkingConfiguration: {
        public: {
          sourceAllowRules: [{
            cidr: 'cidr',
          }],
        },
        vpc: {
          securityGroupIds: ['securityGroupIds'],
          subnetId: 'subnetId',
        },
      },

      // the properties below are optional
      protocol: 'protocol',
      sourceNetworkingType: 'sourceNetworkingType',
    },
  },

  // the properties below are optional
  description: 'description',
  regionName: 'regionName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mediaconnect as mediaconnect

cfn_source_endpoint_props = mediaconnect.CfnSourceEndpointProps(
    configuration=mediaconnect.CfnSourceEndpoint.SourceEndpointConfigurationProperty(
        router_output=mediaconnect.CfnSourceEndpoint.RouterOutputSourceEndpointConfigurationProperty(
            router_output_arn="routerOutputArn"
        ),
        standard=mediaconnect.CfnSourceEndpoint.StandardSourceEndpointConfigurationProperty(
            name="name",
            protocol_configuration=mediaconnect.CfnSourceEndpoint.StandardSourceEndpointProtocolConfigurationProperty(
                rist=mediaconnect.CfnSourceEndpoint.RistStandardSourceEndpointConfigurationProperty(
                    destination_ingest_port=123,
                    recovery_latency_milliseconds=123
                ),
                rtp=mediaconnect.CfnSourceEndpoint.RtpStandardSourceEndpointConfigurationProperty(
                    destination_ingest_port=123,
                    forward_error_correction_state="forwardErrorCorrectionState"
                ),
                srt_caller=mediaconnect.CfnSourceEndpoint.SrtCallerStandardSourceEndpointConfigurationProperty(
                    destination_ingest_port=123,
                    minimum_latency_milliseconds=123,

                    # the properties below are optional
                    encryption_passphrase=mediaconnect.CfnSourceEndpoint.EndpointEncryptionSecretConfigurationProperty(
                        secret_arn="secretArn"
                    )
                ),
                srt_listener=mediaconnect.CfnSourceEndpoint.SrtListenerStandardSourceEndpointConfigurationProperty(
                    minimum_latency_milliseconds=123,
                    source_address="sourceAddress",
                    source_listener_port=123,

                    # the properties below are optional
                    encryption_passphrase=mediaconnect.CfnSourceEndpoint.EndpointEncryptionSecretConfigurationProperty(
                        secret_arn="secretArn"
                    ),
                    stream_id="streamId"
                )
            ),
            source_networking_configuration=mediaconnect.CfnSourceEndpoint.StandardSourceEndpointNetworkingConfigurationProperty(
                public=mediaconnect.CfnSourceEndpoint.PublicSourceEndpointNetworkingConfigurationProperty(
                    source_allow_rules=[mediaconnect.CfnSourceEndpoint.PublicSourceEndpointNetworkingConfigurationAllowRuleProperty(
                        cidr="cidr"
                    )]
                ),
                vpc=mediaconnect.CfnSourceEndpoint.VpcSourceEndpointNetworkingConfigurationProperty(
                    security_group_ids=["securityGroupIds"],
                    subnet_id="subnetId"
                )
            ),

            # the properties below are optional
            protocol="protocol",
            source_networking_type="sourceNetworkingType"
        )
    ),

    # the properties below are optional
    description="description",
    region_name="regionName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.mediaconnect.*;

CfnSourceEndpointProps cfnSourceEndpointProps = CfnSourceEndpointProps.builder()
        .configuration(SourceEndpointConfigurationProperty.builder()
                .routerOutput(RouterOutputSourceEndpointConfigurationProperty.builder()
                        .routerOutputArn("routerOutputArn")
                        .build())
                .standard(StandardSourceEndpointConfigurationProperty.builder()
                        .name("name")
                        .protocolConfiguration(StandardSourceEndpointProtocolConfigurationProperty.builder()
                                .rist(RistStandardSourceEndpointConfigurationProperty.builder()
                                        .destinationIngestPort(123)
                                        .recoveryLatencyMilliseconds(123)
                                        .build())
                                .rtp(RtpStandardSourceEndpointConfigurationProperty.builder()
                                        .destinationIngestPort(123)
                                        .forwardErrorCorrectionState("forwardErrorCorrectionState")
                                        .build())
                                .srtCaller(SrtCallerStandardSourceEndpointConfigurationProperty.builder()
                                        .destinationIngestPort(123)
                                        .minimumLatencyMilliseconds(123)

                                        // the properties below are optional
                                        .encryptionPassphrase(EndpointEncryptionSecretConfigurationProperty.builder()
                                                .secretArn("secretArn")
                                                .build())
                                        .build())
                                .srtListener(SrtListenerStandardSourceEndpointConfigurationProperty.builder()
                                        .minimumLatencyMilliseconds(123)
                                        .sourceAddress("sourceAddress")
                                        .sourceListenerPort(123)

                                        // the properties below are optional
                                        .encryptionPassphrase(EndpointEncryptionSecretConfigurationProperty.builder()
                                                .secretArn("secretArn")
                                                .build())
                                        .streamId("streamId")
                                        .build())
                                .build())
                        .sourceNetworkingConfiguration(StandardSourceEndpointNetworkingConfigurationProperty.builder()
                                .public(PublicSourceEndpointNetworkingConfigurationProperty.builder()
                                        .sourceAllowRules(List.of(PublicSourceEndpointNetworkingConfigurationAllowRuleProperty.builder()
                                                .cidr("cidr")
                                                .build()))
                                        .build())
                                .vpc(VpcSourceEndpointNetworkingConfigurationProperty.builder()
                                        .securityGroupIds(List.of("securityGroupIds"))
                                        .subnetId("subnetId")
                                        .build())
                                .build())

                        // the properties below are optional
                        .protocol("protocol")
                        .sourceNetworkingType("sourceNetworkingType")
                        .build())
                .build())

        // the properties below are optional
        .description("description")
        .regionName("regionName")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MediaConnect;

var cfnSourceEndpointProps = new CfnSourceEndpointProps {
    Configuration = new SourceEndpointConfigurationProperty {
        RouterOutput = new RouterOutputSourceEndpointConfigurationProperty {
            RouterOutputArn = "routerOutputArn"
        },
        Standard = new StandardSourceEndpointConfigurationProperty {
            Name = "name",
            ProtocolConfiguration = new StandardSourceEndpointProtocolConfigurationProperty {
                Rist = new RistStandardSourceEndpointConfigurationProperty {
                    DestinationIngestPort = 123,
                    RecoveryLatencyMilliseconds = 123
                },
                Rtp = new RtpStandardSourceEndpointConfigurationProperty {
                    DestinationIngestPort = 123,
                    ForwardErrorCorrectionState = "forwardErrorCorrectionState"
                },
                SrtCaller = new SrtCallerStandardSourceEndpointConfigurationProperty {
                    DestinationIngestPort = 123,
                    MinimumLatencyMilliseconds = 123,

                    // the properties below are optional
                    EncryptionPassphrase = new EndpointEncryptionSecretConfigurationProperty {
                        SecretArn = "secretArn"
                    }
                },
                SrtListener = new SrtListenerStandardSourceEndpointConfigurationProperty {
                    MinimumLatencyMilliseconds = 123,
                    SourceAddress = "sourceAddress",
                    SourceListenerPort = 123,

                    // the properties below are optional
                    EncryptionPassphrase = new EndpointEncryptionSecretConfigurationProperty {
                        SecretArn = "secretArn"
                    },
                    StreamId = "streamId"
                }
            },
            SourceNetworkingConfiguration = new StandardSourceEndpointNetworkingConfigurationProperty {
                Public = new PublicSourceEndpointNetworkingConfigurationProperty {
                    SourceAllowRules = new [] { new PublicSourceEndpointNetworkingConfigurationAllowRuleProperty {
                        Cidr = "cidr"
                    } }
                },
                Vpc = new VpcSourceEndpointNetworkingConfigurationProperty {
                    SecurityGroupIds = new [] { "securityGroupIds" },
                    SubnetId = "subnetId"
                }
            },

            // the properties below are optional
            Protocol = "protocol",
            SourceNetworkingType = "sourceNetworkingType"
        }
    },

    // the properties below are optional
    Description = "description",
    RegionName = "regionName",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnSourceEndpointProps := &CfnSourceEndpointProps{
	Configuration: &SourceEndpointConfigurationProperty{
		RouterOutput: &RouterOutputSourceEndpointConfigurationProperty{
			RouterOutputArn: jsii.String("routerOutputArn"),
		},
		Standard: &StandardSourceEndpointConfigurationProperty{
			Name: jsii.String("name"),
			ProtocolConfiguration: &StandardSourceEndpointProtocolConfigurationProperty{
				Rist: &RistStandardSourceEndpointConfigurationProperty{
					DestinationIngestPort: jsii.Number(123),
					RecoveryLatencyMilliseconds: jsii.Number(123),
				},
				Rtp: &RtpStandardSourceEndpointConfigurationProperty{
					DestinationIngestPort: jsii.Number(123),
					ForwardErrorCorrectionState: jsii.String("forwardErrorCorrectionState"),
				},
				SrtCaller: &SrtCallerStandardSourceEndpointConfigurationProperty{
					DestinationIngestPort: jsii.Number(123),
					MinimumLatencyMilliseconds: jsii.Number(123),

					// the properties below are optional
					EncryptionPassphrase: &EndpointEncryptionSecretConfigurationProperty{
						SecretArn: jsii.String("secretArn"),
					},
				},
				SrtListener: &SrtListenerStandardSourceEndpointConfigurationProperty{
					MinimumLatencyMilliseconds: jsii.Number(123),
					SourceAddress: jsii.String("sourceAddress"),
					SourceListenerPort: jsii.Number(123),

					// the properties below are optional
					EncryptionPassphrase: &EndpointEncryptionSecretConfigurationProperty{
						SecretArn: jsii.String("secretArn"),
					},
					StreamId: jsii.String("streamId"),
				},
			},
			SourceNetworkingConfiguration: &StandardSourceEndpointNetworkingConfigurationProperty{
				Public: &PublicSourceEndpointNetworkingConfigurationProperty{
					SourceAllowRules: []interface{}{
						&PublicSourceEndpointNetworkingConfigurationAllowRuleProperty{
							Cidr: jsii.String("cidr"),
						},
					},
				},
				Vpc: &VpcSourceEndpointNetworkingConfigurationProperty{
					SecurityGroupIds: []*string{
						jsii.String("securityGroupIds"),
					},
					SubnetId: jsii.String("subnetId"),
				},
			},

			// the properties below are optional
			Protocol: jsii.String("protocol"),
			SourceNetworkingType: jsii.String("sourceNetworkingType"),
		},
	},

	// the properties below are optional
	Description: jsii.String("description"),
	RegionName: jsii.String("regionName"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

configurationIResolvable | CfnSourceEndpoint.SourceEndpointConfigurationPropertyconfigurationtyping.Union[IResolvable, SourceEndpointConfigurationProperty]configurationIResolvableConfigurationIResolvableConfigurationinterface{}required#
The configuration settings for a source endpoint.

This is a union type, so exactly one of its members is set, depending on the type of the source endpoint.

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the source endpoint.
regionNameoptionalstringregion_nameoptionalstrregionNameoptionalStringRegionNameoptionalstringRegionNameoptional*string#
The name of the Amazon Web Services Region in which the source endpoint is located.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags associated with the source endpoint.

Each tag is a key-value pair.