EC2 / Client / create_transit_gateway_multicast_domain

create_transit_gateway_multicast_domain#

EC2.Client.create_transit_gateway_multicast_domain(**kwargs)#

Creates a multicast domain using the specified transit gateway.

The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.

Request Syntax

response = client.create_transit_gateway_multicast_domain(
    TransitGatewayId='string',
    Options={
        'Igmpv2Support': 'enable'|'disable',
        'StaticSourcesSupport': 'enable'|'disable',
        'AutoAcceptSharedAssociations': 'enable'|'disable'
    },
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'declarative-policies-report'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'verified-access-endpoint-target'|'ipam-external-resource-verification-token',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    DryRun=True|False
)

Parameters:

TransitGatewayId (string) –
[REQUIRED]

The ID of the transit gateway.
Options (dict) –
The options for the transit gateway multicast domain.
- Igmpv2Support (string) –
  
  Specify whether to enable Internet Group Management Protocol (IGMP) version 2 for the transit gateway multicast domain.
- StaticSourcesSupport (string) –
  
  Specify whether to enable support for statically configuring multicast group sources for a domain.
- AutoAcceptSharedAssociations (string) –
  
  Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain.
TagSpecifications (list) –
The tags for the transit gateway multicast domain.
- (dict) –
  
  The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
  
  Note
  The Valid Values lists all the resource types that can be tagged. However, the action you’re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you’re using, you’ll get an error.
  - ResourceType (string) –
    
    The type of resource to tag on creation.
  - Tags (list) –
    
    The tags to apply to the resource.
    - (dict) –
      
      Describes a tag.
      - Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
      - Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

dict

Returns:

Response Syntax

{
    'TransitGatewayMulticastDomain': {
        'TransitGatewayMulticastDomainId': 'string',
        'TransitGatewayId': 'string',
        'TransitGatewayMulticastDomainArn': 'string',
        'OwnerId': 'string',
        'Options': {
            'Igmpv2Support': 'enable'|'disable',
            'StaticSourcesSupport': 'enable'|'disable',
            'AutoAcceptSharedAssociations': 'enable'|'disable'
        },
        'State': 'pending'|'available'|'deleting'|'deleted',
        'CreationTime': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- TransitGatewayMulticastDomain (dict) –
  
  Information about the transit gateway multicast domain.
  - TransitGatewayMulticastDomainId (string) –
    
    The ID of the transit gateway multicast domain.
  - TransitGatewayId (string) –
    
    The ID of the transit gateway.
  - TransitGatewayMulticastDomainArn (string) –
    
    The Amazon Resource Name (ARN) of the transit gateway multicast domain.
  - OwnerId (string) –
    
    The ID of the Amazon Web Services account that owns the transit gateway multicast domain.
  - Options (dict) –
    
    The options for the transit gateway multicast domain.
    - Igmpv2Support (string) –
      
      Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain.
    - StaticSourcesSupport (string) –
      
      Indicates whether support for statically configuring transit gateway multicast group sources is turned on.
    - AutoAcceptSharedAssociations (string) –
      
      Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.
  - State (string) –
    
    The state of the transit gateway multicast domain.
  - CreationTime (datetime) –
    
    The time the transit gateway multicast domain was created.
  - Tags (list) –
    
    The tags for the transit gateway multicast domain.
    - (dict) –
      
      Describes a tag.
      - Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
      - Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.