1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. mediaconnect
  6. Gateway

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.85.0
published on Monday, Nov 2, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.85.0
published on Monday, Nov 2, 2026 by Pulumi

    Resource schema for AWS::MediaConnect::Gateway

    Create Gateway Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);
    @overload
    def Gateway(resource_name: str,
                args: GatewayArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Gateway(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                egress_cidr_blocks: Optional[Sequence[str]] = None,
                networks: Optional[Sequence[GatewayNetworkArgs]] = None,
                name: Optional[str] = None)
    func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)
    public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
    public Gateway(String name, GatewayArgs args)
    public Gateway(String name, GatewayArgs args, CustomResourceOptions options)
    
    type: aws-native:mediaconnect:Gateway
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_mediaconnect_gateway" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args GatewayArgs
    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 GatewayArgs
    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 GatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Gateway 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 Gateway resource accepts the following input properties:

    EgressCidrBlocks List<string>
    The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    Networks List<Pulumi.AwsNative.MediaConnect.Inputs.GatewayNetwork>
    The list of networks in the gateway.
    Name string
    The name of the gateway. This name can not be modified after the gateway is created.
    EgressCidrBlocks []string
    The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    Networks []GatewayNetworkArgs
    The list of networks in the gateway.
    Name string
    The name of the gateway. This name can not be modified after the gateway is created.
    egress_cidr_blocks list(string)
    The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    networks list(object)
    The list of networks in the gateway.
    name string
    The name of the gateway. This name can not be modified after the gateway is created.
    egressCidrBlocks List<String>
    The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    networks List<GatewayNetwork>
    The list of networks in the gateway.
    name String
    The name of the gateway. This name can not be modified after the gateway is created.
    egressCidrBlocks string[]
    The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    networks GatewayNetwork[]
    The list of networks in the gateway.
    name string
    The name of the gateway. This name can not be modified after the gateway is created.
    egress_cidr_blocks Sequence[str]
    The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    networks Sequence[GatewayNetworkArgs]
    The list of networks in the gateway.
    name str
    The name of the gateway. This name can not be modified after the gateway is created.
    egressCidrBlocks List<String>
    The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    networks List<Property Map>
    The list of networks in the gateway.
    name String
    The name of the gateway. This name can not be modified after the gateway is created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Gateway resource produces the following output properties:

    GatewayArn string
    The Amazon Resource Name (ARN) of the gateway.
    GatewayState Pulumi.AwsNative.MediaConnect.GatewayState
    The current status of the gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    GatewayArn string
    The Amazon Resource Name (ARN) of the gateway.
    GatewayState GatewayStateEnum
    The current status of the gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    gateway_arn string
    The Amazon Resource Name (ARN) of the gateway.
    gateway_state "CREATING" | "ACTIVE" | "UPDATING" | "ERROR" | "DELETING" | "DELETED"
    The current status of the gateway.
    id string
    The provider-assigned unique ID for this managed resource.
    gatewayArn String
    The Amazon Resource Name (ARN) of the gateway.
    gatewayState GatewayState
    The current status of the gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    gatewayArn string
    The Amazon Resource Name (ARN) of the gateway.
    gatewayState GatewayState
    The current status of the gateway.
    id string
    The provider-assigned unique ID for this managed resource.
    gateway_arn str
    The Amazon Resource Name (ARN) of the gateway.
    gateway_state GatewayState
    The current status of the gateway.
    id str
    The provider-assigned unique ID for this managed resource.
    gatewayArn String
    The Amazon Resource Name (ARN) of the gateway.
    gatewayState "CREATING" | "ACTIVE" | "UPDATING" | "ERROR" | "DELETING" | "DELETED"
    The current status of the gateway.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Gateway Resource

    Get an existing Gateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): Gateway
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> Gateway
    func GetGateway(ctx *Context, name string, id IDInput, state *GatewayState, opts ...ResourceOption) (*Gateway, error)
    public static Gateway Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static Gateway get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingGateway:    type: aws-native:mediaconnect:Gateway    get:      id: ${id}
    import {
      to = aws-native_mediaconnect_gateway.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state GatewayState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    GatewayNetwork, GatewayNetworkArgs

    The network settings for a gateway.
    CidrBlock string
    A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    Name string
    The name of the network. This name is used to reference the network and must be unique among networks in this gateway.
    CidrBlock string
    A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    Name string
    The name of the network. This name is used to reference the network and must be unique among networks in this gateway.
    cidr_block string
    A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    name string
    The name of the network. This name is used to reference the network and must be unique among networks in this gateway.
    cidrBlock String
    A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    name String
    The name of the network. This name is used to reference the network and must be unique among networks in this gateway.
    cidrBlock string
    A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    name string
    The name of the network. This name is used to reference the network and must be unique among networks in this gateway.
    cidr_block str
    A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    name str
    The name of the network. This name is used to reference the network and must be unique among networks in this gateway.
    cidrBlock String
    A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
    name String
    The name of the network. This name is used to reference the network and must be unique among networks in this gateway.

    GatewayState, GatewayStateArgs

    The current status of the gateway.
    NameValue
    CreatingCREATING
    ActiveACTIVE
    UpdatingUPDATING
    ErrorERROR
    DeletingDELETING
    DeletedDELETED
    NameValue
    GatewayStateCreatingCREATING
    GatewayStateActiveACTIVE
    GatewayStateUpdatingUPDATING
    GatewayStateErrorERROR
    GatewayStateDeletingDELETING
    GatewayStateDeletedDELETED
    Value
    CREATING
    ACTIVE
    UPDATING
    ERROR
    DELETING
    DELETED
    NameValue
    CreatingCREATING
    ActiveACTIVE
    UpdatingUPDATING
    ErrorERROR
    DeletingDELETING
    DeletedDELETED
    NameValue
    CreatingCREATING
    ActiveACTIVE
    UpdatingUPDATING
    ErrorERROR
    DeletingDELETING
    DeletedDELETED
    NameValue
    CREATINGCREATING
    ACTIVEACTIVE
    UPDATINGUPDATING
    ERRORERROR
    DELETINGDELETING
    DELETEDDELETED
    Value
    CREATING
    ACTIVE
    UPDATING
    ERROR
    DELETING
    DELETED

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.85.0
    published on Monday, Nov 2, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial