Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. ec2transitgateway
  5. MulticastGroupMember

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-aws

aws.ec2transitgateway.MulticastGroupMember

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.31.1 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-aws

    Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic.

    Example Usage

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

const example = new aws.ec2transitgateway.MulticastGroupMember("example", {
    groupIpAddress: "224.0.0.1",
    networkInterfaceId: exampleAwsNetworkInterface.id,
    transitGatewayMulticastDomainId: exampleAwsEc2TransitGatewayMulticastDomain.id,
});

    import pulumi
import pulumi_aws as aws

example = aws.ec2transitgateway.MulticastGroupMember("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"])

    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.NewMulticastGroupMember(ctx, "example", &ec2transitgateway.MulticastGroupMemberArgs{
			GroupIpAddress:                  pulumi.String("224.0.0.1"),
			NetworkInterfaceId:              pulumi.Any(exampleAwsNetworkInterface.Id),
			TransitGatewayMulticastDomainId: pulumi.Any(exampleAwsEc2TransitGatewayMulticastDomain.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

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

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2transitgateway.MulticastGroupMember;
import com.pulumi.aws.ec2transitgateway.MulticastGroupMemberArgs;
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 MulticastGroupMember("example", MulticastGroupMemberArgs.builder()        
            .groupIpAddress("224.0.0.1")
            .networkInterfaceId(exampleAwsNetworkInterface.id())
            .transitGatewayMulticastDomainId(exampleAwsEc2TransitGatewayMulticastDomain.id())
            .build());

    }
}

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

    Create MulticastGroupMember Resource

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

    Constructor syntax

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

@overload
def MulticastGroupMember(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 NewMulticastGroupMember(ctx *Context, name string, args MulticastGroupMemberArgs, opts ...ResourceOption) (*MulticastGroupMember, error)
    public MulticastGroupMember(string name, MulticastGroupMemberArgs args, CustomResourceOptions? opts = null)
    public MulticastGroupMember(String name, MulticastGroupMemberArgs args)
public MulticastGroupMember(String name, MulticastGroupMemberArgs args, CustomResourceOptions options)

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

    Example

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

    var multicastGroupMemberResource = new Aws.Ec2TransitGateway.MulticastGroupMember("multicastGroupMemberResource", new()
{
    GroupIpAddress = "string",
    NetworkInterfaceId = "string",
    TransitGatewayMulticastDomainId = "string",
});

    example, err := ec2transitgateway.NewMulticastGroupMember(ctx, "multicastGroupMemberResource", &ec2transitgateway.MulticastGroupMemberArgs{
	GroupIpAddress:                  pulumi.String("string"),
	NetworkInterfaceId:              pulumi.String("string"),
	TransitGatewayMulticastDomainId: pulumi.String("string"),
})

    var multicastGroupMemberResource = new MulticastGroupMember("multicastGroupMemberResource", MulticastGroupMemberArgs.builder()        
    .groupIpAddress("string")
    .networkInterfaceId("string")
    .transitGatewayMulticastDomainId("string")
    .build());

    multicast_group_member_resource = aws.ec2transitgateway.MulticastGroupMember("multicastGroupMemberResource",
    group_ip_address="string",
    network_interface_id="string",
    transit_gateway_multicast_domain_id="string")

    const multicastGroupMemberResource = new aws.ec2transitgateway.MulticastGroupMember("multicastGroupMemberResource", {
    groupIpAddress: "string",
    networkInterfaceId: "string",
    transitGatewayMulticastDomainId: "string",
});

    type: aws:ec2transitgateway:MulticastGroupMember
properties:
    groupIpAddress: string
    networkInterfaceId: string
    transitGatewayMulticastDomainId: string

    MulticastGroupMember Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The MulticastGroupMember resource accepts the following input properties:

    GroupIpAddress string
    The IP address assigned to the transit gateway multicast group.
    NetworkInterfaceId string
    The group members' network interface ID to register with the transit gateway multicast group.
    TransitGatewayMulticastDomainId string
    The ID of the transit gateway multicast domain.
    GroupIpAddress string
    The IP address assigned to the transit gateway multicast group.
    NetworkInterfaceId string
    The group members' network interface ID to register with the transit gateway multicast group.
    TransitGatewayMulticastDomainId string
    The ID of the transit gateway multicast domain.
    groupIpAddress String
    The IP address assigned to the transit gateway multicast group.
    networkInterfaceId String
    The group members' network interface ID to register with the transit gateway multicast group.
    transitGatewayMulticastDomainId String
    The ID of the transit gateway multicast domain.
    groupIpAddress string
    The IP address assigned to the transit gateway multicast group.
    networkInterfaceId string
    The group members' network interface ID to register with the transit gateway multicast group.
    transitGatewayMulticastDomainId string
    The ID of the transit gateway multicast domain.
    group_ip_address str
    The IP address assigned to the transit gateway multicast group.
    network_interface_id str
    The group members' network interface ID to register with the transit gateway multicast group.
    transit_gateway_multicast_domain_id str
    The ID of the transit gateway multicast domain.
    groupIpAddress String
    The IP address assigned to the transit gateway multicast group.
    networkInterfaceId String
    The group members' network interface ID to register with the transit gateway multicast group.
    transitGatewayMulticastDomainId String
    The ID of the transit gateway multicast domain.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MulticastGroupMember 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 MulticastGroupMember Resource

    Get an existing MulticastGroupMember 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?: MulticastGroupMemberState, opts?: CustomResourceOptions): MulticastGroupMember
    @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) -> MulticastGroupMember
    func GetMulticastGroupMember(ctx *Context, name string, id IDInput, state *MulticastGroupMemberState, opts ...ResourceOption) (*MulticastGroupMember, error)
    public static MulticastGroupMember Get(string name, Input<string> id, MulticastGroupMemberState? state, CustomResourceOptions? opts = null)
    public static MulticastGroupMember get(String name, Output<String> id, MulticastGroupMemberState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 string
    The IP address assigned to the transit gateway multicast group.
    NetworkInterfaceId string
    The group members' network interface ID to register with the transit gateway multicast group.
    TransitGatewayMulticastDomainId string
    The ID of the transit gateway multicast domain.
    GroupIpAddress string
    The IP address assigned to the transit gateway multicast group.
    NetworkInterfaceId string
    The group members' network interface ID to register with the transit gateway multicast group.
    TransitGatewayMulticastDomainId string
    The ID of the transit gateway multicast domain.
    groupIpAddress String
    The IP address assigned to the transit gateway multicast group.
    networkInterfaceId String
    The group members' network interface ID to register with the transit gateway multicast group.
    transitGatewayMulticastDomainId String
    The ID of the transit gateway multicast domain.
    groupIpAddress string
    The IP address assigned to the transit gateway multicast group.
    networkInterfaceId string
    The group members' network interface ID to register with the transit gateway multicast group.
    transitGatewayMulticastDomainId string
    The ID of the transit gateway multicast domain.
    group_ip_address str
    The IP address assigned to the transit gateway multicast group.
    network_interface_id str
    The group members' network interface ID to register with the transit gateway multicast group.
    transit_gateway_multicast_domain_id str
    The ID of the transit gateway multicast domain.
    groupIpAddress String
    The IP address assigned to the transit gateway multicast group.
    networkInterfaceId String
    The group members' network interface ID to register with the transit gateway multicast group.
    transitGatewayMulticastDomainId 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 logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.31.1 published on Thursday, Apr 18, 2024 by Pulumi
    pulumi/pulumi-aws