Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ec2transitgateway
  5. MulticastGroupSource
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.ec2transitgateway.MulticastGroupSource

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Registers sources (network interfaces) with the transit gateway multicast group. A multicast source is a network interface attached to a supported instance that sends multicast traffic.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ec2transitgateway.MulticastGroupSource("example", {
    groupIpAddress: "224.0.0.1",
    networkInterfaceId: exampleAwsNetworkInterface.id,
    transitGatewayMulticastDomainId: exampleAwsEc2TransitGatewayMulticastDomain.id,
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.MulticastGroupSource("example",
    group_ip_address="224.0.0.1",
    network_interface_id=example_aws_network_interface["id"],
    transit_gateway_multicast_domain_id=example_aws_ec2_transit_gateway_multicast_domain["id"])
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2transitgateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2transitgateway.NewMulticastGroupSource(ctx, "example", &ec2transitgateway.MulticastGroupSourceArgs{
			GroupIpAddress:                  pulumi.String("224.0.0.1"),
			NetworkInterfaceId:              pulumi.Any(exampleAwsNetworkInterface.Id),
			TransitGatewayMulticastDomainId: pulumi.Any(exampleAwsEc2TransitGatewayMulticastDomain.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Ec2TransitGateway.MulticastGroupSource("example", new()
    {
        GroupIpAddress = "224.0.0.1",
        NetworkInterfaceId = exampleAwsNetworkInterface.Id,
        TransitGatewayMulticastDomainId = exampleAwsEc2TransitGatewayMulticastDomain.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2transitgateway.MulticastGroupSource;
import com.pulumi.aws.ec2transitgateway.MulticastGroupSourceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new MulticastGroupSource("example", MulticastGroupSourceArgs.builder()
            .groupIpAddress("224.0.0.1")
            .networkInterfaceId(exampleAwsNetworkInterface.id())
            .transitGatewayMulticastDomainId(exampleAwsEc2TransitGatewayMulticastDomain.id())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:ec2transitgateway:MulticastGroupSource
    properties:
      groupIpAddress: 224.0.0.1
      networkInterfaceId: ${exampleAwsNetworkInterface.id}
      transitGatewayMulticastDomainId: ${exampleAwsEc2TransitGatewayMulticastDomain.id}
Copy

Create MulticastGroupSource Resource

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

Constructor syntax

new MulticastGroupSource(name: string, args: MulticastGroupSourceArgs, opts?: CustomResourceOptions);
@overload
def MulticastGroupSource(resource_name: str,
                         args: MulticastGroupSourceArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def MulticastGroupSource(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         group_ip_address: Optional[str] = None,
                         network_interface_id: Optional[str] = None,
                         transit_gateway_multicast_domain_id: Optional[str] = None)
func NewMulticastGroupSource(ctx *Context, name string, args MulticastGroupSourceArgs, opts ...ResourceOption) (*MulticastGroupSource, error)
public MulticastGroupSource(string name, MulticastGroupSourceArgs args, CustomResourceOptions? opts = null)
public MulticastGroupSource(String name, MulticastGroupSourceArgs args)
public MulticastGroupSource(String name, MulticastGroupSourceArgs args, CustomResourceOptions options)

type: aws:ec2transitgateway:MulticastGroupSource
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. MulticastGroupSourceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. MulticastGroupSourceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. MulticastGroupSourceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MulticastGroupSourceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. MulticastGroupSourceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var multicastGroupSourceResource = new Aws.Ec2TransitGateway.MulticastGroupSource("multicastGroupSourceResource", new()
{
    GroupIpAddress = "string",
    NetworkInterfaceId = "string",
    TransitGatewayMulticastDomainId = "string",
});
Copy
example, err := ec2transitgateway.NewMulticastGroupSource(ctx, "multicastGroupSourceResource", &ec2transitgateway.MulticastGroupSourceArgs{
	GroupIpAddress:                  pulumi.String("string"),
	NetworkInterfaceId:              pulumi.String("string"),
	TransitGatewayMulticastDomainId: pulumi.String("string"),
})
Copy
var multicastGroupSourceResource = new MulticastGroupSource("multicastGroupSourceResource", MulticastGroupSourceArgs.builder()
    .groupIpAddress("string")
    .networkInterfaceId("string")
    .transitGatewayMulticastDomainId("string")
    .build());
Copy
multicast_group_source_resource = aws.ec2transitgateway.MulticastGroupSource("multicastGroupSourceResource",
    group_ip_address="string",
    network_interface_id="string",
    transit_gateway_multicast_domain_id="string")
Copy
const multicastGroupSourceResource = new aws.ec2transitgateway.MulticastGroupSource("multicastGroupSourceResource", {
    groupIpAddress: "string",
    networkInterfaceId: "string",
    transitGatewayMulticastDomainId: "string",
});
Copy
type: aws:ec2transitgateway:MulticastGroupSource
properties:
    groupIpAddress: string
    networkInterfaceId: string
    transitGatewayMulticastDomainId: string
Copy

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

GroupIpAddress
This property is required.
Changes to this property will trigger replacement.
string
The IP address assigned to the transit gateway multicast group.
NetworkInterfaceId
This property is required.
Changes to this property will trigger replacement.
string
The group members' network interface ID to register with the transit gateway multicast group.
TransitGatewayMulticastDomainId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the transit gateway multicast domain.
GroupIpAddress
This property is required.
Changes to this property will trigger replacement.
string
The IP address assigned to the transit gateway multicast group.
NetworkInterfaceId
This property is required.
Changes to this property will trigger replacement.
string
The group members' network interface ID to register with the transit gateway multicast group.
TransitGatewayMulticastDomainId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the transit gateway multicast domain.
groupIpAddress
This property is required.
Changes to this property will trigger replacement.
String
The IP address assigned to the transit gateway multicast group.
networkInterfaceId
This property is required.
Changes to this property will trigger replacement.
String
The group members' network interface ID to register with the transit gateway multicast group.
transitGatewayMulticastDomainId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the transit gateway multicast domain.
groupIpAddress
This property is required.
Changes to this property will trigger replacement.
string
The IP address assigned to the transit gateway multicast group.
networkInterfaceId
This property is required.
Changes to this property will trigger replacement.
string
The group members' network interface ID to register with the transit gateway multicast group.
transitGatewayMulticastDomainId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the transit gateway multicast domain.
group_ip_address
This property is required.
Changes to this property will trigger replacement.
str
The IP address assigned to the transit gateway multicast group.
network_interface_id
This property is required.
Changes to this property will trigger replacement.
str
The group members' network interface ID to register with the transit gateway multicast group.
transit_gateway_multicast_domain_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the transit gateway multicast domain.
groupIpAddress
This property is required.
Changes to this property will trigger replacement.
String
The IP address assigned to the transit gateway multicast group.
networkInterfaceId
This property is required.
Changes to this property will trigger replacement.
String
The group members' network interface ID to register with the transit gateway multicast group.
transitGatewayMulticastDomainId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the transit gateway multicast domain.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing MulticastGroupSource Resource

Get an existing MulticastGroupSource 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>, state?: MulticastGroupSourceState, opts?: CustomResourceOptions): MulticastGroupSource
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        group_ip_address: Optional[str] = None,
        network_interface_id: Optional[str] = None,
        transit_gateway_multicast_domain_id: Optional[str] = None) -> MulticastGroupSource
func GetMulticastGroupSource(ctx *Context, name string, id IDInput, state *MulticastGroupSourceState, opts ...ResourceOption) (*MulticastGroupSource, error)
public static MulticastGroupSource Get(string name, Input<string> id, MulticastGroupSourceState? state, CustomResourceOptions? opts = null)
public static MulticastGroupSource get(String name, Output<String> id, MulticastGroupSourceState state, CustomResourceOptions options)
resources:  _:    type: aws:ec2transitgateway:MulticastGroupSource    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
GroupIpAddress Changes to this property will trigger replacement. string
The IP address assigned to the transit gateway multicast group.
NetworkInterfaceId Changes to this property will trigger replacement. string
The group members' network interface ID to register with the transit gateway multicast group.
TransitGatewayMulticastDomainId Changes to this property will trigger replacement. string
The ID of the transit gateway multicast domain.
GroupIpAddress Changes to this property will trigger replacement. string
The IP address assigned to the transit gateway multicast group.
NetworkInterfaceId Changes to this property will trigger replacement. string
The group members' network interface ID to register with the transit gateway multicast group.
TransitGatewayMulticastDomainId Changes to this property will trigger replacement. string
The ID of the transit gateway multicast domain.
groupIpAddress Changes to this property will trigger replacement. String
The IP address assigned to the transit gateway multicast group.
networkInterfaceId Changes to this property will trigger replacement. String
The group members' network interface ID to register with the transit gateway multicast group.
transitGatewayMulticastDomainId Changes to this property will trigger replacement. String
The ID of the transit gateway multicast domain.
groupIpAddress Changes to this property will trigger replacement. string
The IP address assigned to the transit gateway multicast group.
networkInterfaceId Changes to this property will trigger replacement. string
The group members' network interface ID to register with the transit gateway multicast group.
transitGatewayMulticastDomainId Changes to this property will trigger replacement. string
The ID of the transit gateway multicast domain.
group_ip_address Changes to this property will trigger replacement. str
The IP address assigned to the transit gateway multicast group.
network_interface_id Changes to this property will trigger replacement. str
The group members' network interface ID to register with the transit gateway multicast group.
transit_gateway_multicast_domain_id Changes to this property will trigger replacement. str
The ID of the transit gateway multicast domain.
groupIpAddress Changes to this property will trigger replacement. String
The IP address assigned to the transit gateway multicast group.
networkInterfaceId Changes to this property will trigger replacement. String
The group members' network interface ID to register with the transit gateway multicast group.
transitGatewayMulticastDomainId Changes to this property will trigger replacement. String
The ID of the transit gateway multicast domain.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws