1. Packages
  2. Vmc Provider
  3. API Docs
  4. SddcGroup
vmc 1.15.4 published on Monday, Apr 21, 2025 by vmware

vmc.SddcGroup

Explore with Pulumi AI

vmc logo
vmc 1.15.4 published on Monday, Apr 21, 2025 by vmware

    Provides a resource to add SDDCs into an SDDC Group.

    Create SddcGroup Resource

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

    Constructor syntax

    new SddcGroup(name: string, args: SddcGroupArgs, opts?: CustomResourceOptions);
    @overload
    def SddcGroup(resource_name: str,
                  args: SddcGroupArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def SddcGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  sddc_member_ids: Optional[Sequence[str]] = None,
                  external_tgw_region: Optional[str] = None,
                  dxgw_allowed_prefixes: Optional[str] = None,
                  dxgw_status: Optional[str] = None,
                  external_tgw_configured_prefixes: Optional[str] = None,
                  external_tgw_id: Optional[str] = None,
                  external_tgw_owner: Optional[str] = None,
                  dxgw_id: Optional[str] = None,
                  name: Optional[str] = None,
                  sddc_group_id: Optional[str] = None,
                  dxgw_owner: Optional[str] = None,
                  tgw_id: Optional[str] = None,
                  tgw_region: Optional[str] = None,
                  timeouts: Optional[SddcGroupTimeoutsArgs] = None,
                  vpc_attachment_status: Optional[str] = None,
                  vpc_attachments: Optional[Sequence[SddcGroupVpcAttachmentArgs]] = None,
                  vpc_aws_account: Optional[str] = None,
                  vpc_ram_share_id: Optional[str] = None)
    func NewSddcGroup(ctx *Context, name string, args SddcGroupArgs, opts ...ResourceOption) (*SddcGroup, error)
    public SddcGroup(string name, SddcGroupArgs args, CustomResourceOptions? opts = null)
    public SddcGroup(String name, SddcGroupArgs args)
    public SddcGroup(String name, SddcGroupArgs args, CustomResourceOptions options)
    
    type: vmc:SddcGroup
    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 SddcGroupArgs
    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 SddcGroupArgs
    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 SddcGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SddcGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SddcGroupArgs
    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 sddcGroupResource = new Vmc.SddcGroup("sddcGroupResource", new()
    {
        Description = "string",
        SddcMemberIds = new[]
        {
            "string",
        },
        ExternalTgwRegion = "string",
        DxgwAllowedPrefixes = "string",
        DxgwStatus = "string",
        ExternalTgwConfiguredPrefixes = "string",
        ExternalTgwId = "string",
        ExternalTgwOwner = "string",
        DxgwId = "string",
        Name = "string",
        SddcGroupId = "string",
        DxgwOwner = "string",
        TgwId = "string",
        TgwRegion = "string",
        Timeouts = new Vmc.Inputs.SddcGroupTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Update = "string",
        },
        VpcAttachmentStatus = "string",
        VpcAttachments = new[]
        {
            new Vmc.Inputs.SddcGroupVpcAttachmentArgs
            {
                AttachId = "string",
                ConfiguredPrefixes = "string",
                State = "string",
                VpcId = "string",
            },
        },
        VpcAwsAccount = "string",
        VpcRamShareId = "string",
    });
    
    example, err := vmc.NewSddcGroup(ctx, "sddcGroupResource", &vmc.SddcGroupArgs{
    	Description: pulumi.String("string"),
    	SddcMemberIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ExternalTgwRegion:             pulumi.String("string"),
    	DxgwAllowedPrefixes:           pulumi.String("string"),
    	DxgwStatus:                    pulumi.String("string"),
    	ExternalTgwConfiguredPrefixes: pulumi.String("string"),
    	ExternalTgwId:                 pulumi.String("string"),
    	ExternalTgwOwner:              pulumi.String("string"),
    	DxgwId:                        pulumi.String("string"),
    	Name:                          pulumi.String("string"),
    	SddcGroupId:                   pulumi.String("string"),
    	DxgwOwner:                     pulumi.String("string"),
    	TgwId:                         pulumi.String("string"),
    	TgwRegion:                     pulumi.String("string"),
    	Timeouts: &vmc.SddcGroupTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    	VpcAttachmentStatus: pulumi.String("string"),
    	VpcAttachments: vmc.SddcGroupVpcAttachmentArray{
    		&vmc.SddcGroupVpcAttachmentArgs{
    			AttachId:           pulumi.String("string"),
    			ConfiguredPrefixes: pulumi.String("string"),
    			State:              pulumi.String("string"),
    			VpcId:              pulumi.String("string"),
    		},
    	},
    	VpcAwsAccount: pulumi.String("string"),
    	VpcRamShareId: pulumi.String("string"),
    })
    
    var sddcGroupResource = new SddcGroup("sddcGroupResource", SddcGroupArgs.builder()
        .description("string")
        .sddcMemberIds("string")
        .externalTgwRegion("string")
        .dxgwAllowedPrefixes("string")
        .dxgwStatus("string")
        .externalTgwConfiguredPrefixes("string")
        .externalTgwId("string")
        .externalTgwOwner("string")
        .dxgwId("string")
        .name("string")
        .sddcGroupId("string")
        .dxgwOwner("string")
        .tgwId("string")
        .tgwRegion("string")
        .timeouts(SddcGroupTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .update("string")
            .build())
        .vpcAttachmentStatus("string")
        .vpcAttachments(SddcGroupVpcAttachmentArgs.builder()
            .attachId("string")
            .configuredPrefixes("string")
            .state("string")
            .vpcId("string")
            .build())
        .vpcAwsAccount("string")
        .vpcRamShareId("string")
        .build());
    
    sddc_group_resource = vmc.SddcGroup("sddcGroupResource",
        description="string",
        sddc_member_ids=["string"],
        external_tgw_region="string",
        dxgw_allowed_prefixes="string",
        dxgw_status="string",
        external_tgw_configured_prefixes="string",
        external_tgw_id="string",
        external_tgw_owner="string",
        dxgw_id="string",
        name="string",
        sddc_group_id="string",
        dxgw_owner="string",
        tgw_id="string",
        tgw_region="string",
        timeouts={
            "create": "string",
            "delete": "string",
            "update": "string",
        },
        vpc_attachment_status="string",
        vpc_attachments=[{
            "attach_id": "string",
            "configured_prefixes": "string",
            "state": "string",
            "vpc_id": "string",
        }],
        vpc_aws_account="string",
        vpc_ram_share_id="string")
    
    const sddcGroupResource = new vmc.SddcGroup("sddcGroupResource", {
        description: "string",
        sddcMemberIds: ["string"],
        externalTgwRegion: "string",
        dxgwAllowedPrefixes: "string",
        dxgwStatus: "string",
        externalTgwConfiguredPrefixes: "string",
        externalTgwId: "string",
        externalTgwOwner: "string",
        dxgwId: "string",
        name: "string",
        sddcGroupId: "string",
        dxgwOwner: "string",
        tgwId: "string",
        tgwRegion: "string",
        timeouts: {
            create: "string",
            "delete": "string",
            update: "string",
        },
        vpcAttachmentStatus: "string",
        vpcAttachments: [{
            attachId: "string",
            configuredPrefixes: "string",
            state: "string",
            vpcId: "string",
        }],
        vpcAwsAccount: "string",
        vpcRamShareId: "string",
    });
    
    type: vmc:SddcGroup
    properties:
        description: string
        dxgwAllowedPrefixes: string
        dxgwId: string
        dxgwOwner: string
        dxgwStatus: string
        externalTgwConfiguredPrefixes: string
        externalTgwId: string
        externalTgwOwner: string
        externalTgwRegion: string
        name: string
        sddcGroupId: string
        sddcMemberIds:
            - string
        tgwId: string
        tgwRegion: string
        timeouts:
            create: string
            delete: string
            update: string
        vpcAttachmentStatus: string
        vpcAttachments:
            - attachId: string
              configuredPrefixes: string
              state: string
              vpcId: string
        vpcAwsAccount: string
        vpcRamShareId: string
    

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

    Description string
    Short description of the SDDC Group.
    SddcMemberIds List<string>
    IDs of the SDDCs to be included as members in the SDDC Group.
    DxgwAllowedPrefixes string
    DxgwId string
    DxgwOwner string
    DxgwStatus string
    ExternalTgwConfiguredPrefixes string
    ExternalTgwId string
    ExternalTgwOwner string
    ExternalTgwRegion string
    Name string
    Name of the SDDC Group.
    SddcGroupId string
    TgwId string
    TgwRegion string
    Timeouts SddcGroupTimeouts
    VpcAttachmentStatus string
    VpcAttachments List<SddcGroupVpcAttachment>
    VpcAwsAccount string
    VpcRamShareId string
    Description string
    Short description of the SDDC Group.
    SddcMemberIds []string
    IDs of the SDDCs to be included as members in the SDDC Group.
    DxgwAllowedPrefixes string
    DxgwId string
    DxgwOwner string
    DxgwStatus string
    ExternalTgwConfiguredPrefixes string
    ExternalTgwId string
    ExternalTgwOwner string
    ExternalTgwRegion string
    Name string
    Name of the SDDC Group.
    SddcGroupId string
    TgwId string
    TgwRegion string
    Timeouts SddcGroupTimeoutsArgs
    VpcAttachmentStatus string
    VpcAttachments []SddcGroupVpcAttachmentArgs
    VpcAwsAccount string
    VpcRamShareId string
    description String
    Short description of the SDDC Group.
    sddcMemberIds List<String>
    IDs of the SDDCs to be included as members in the SDDC Group.
    dxgwAllowedPrefixes String
    dxgwId String
    dxgwOwner String
    dxgwStatus String
    externalTgwConfiguredPrefixes String
    externalTgwId String
    externalTgwOwner String
    externalTgwRegion String
    name String
    Name of the SDDC Group.
    sddcGroupId String
    tgwId String
    tgwRegion String
    timeouts SddcGroupTimeouts
    vpcAttachmentStatus String
    vpcAttachments List<SddcGroupVpcAttachment>
    vpcAwsAccount String
    vpcRamShareId String
    description string
    Short description of the SDDC Group.
    sddcMemberIds string[]
    IDs of the SDDCs to be included as members in the SDDC Group.
    dxgwAllowedPrefixes string
    dxgwId string
    dxgwOwner string
    dxgwStatus string
    externalTgwConfiguredPrefixes string
    externalTgwId string
    externalTgwOwner string
    externalTgwRegion string
    name string
    Name of the SDDC Group.
    sddcGroupId string
    tgwId string
    tgwRegion string
    timeouts SddcGroupTimeouts
    vpcAttachmentStatus string
    vpcAttachments SddcGroupVpcAttachment[]
    vpcAwsAccount string
    vpcRamShareId string
    description String
    Short description of the SDDC Group.
    sddcMemberIds List<String>
    IDs of the SDDCs to be included as members in the SDDC Group.
    dxgwAllowedPrefixes String
    dxgwId String
    dxgwOwner String
    dxgwStatus String
    externalTgwConfiguredPrefixes String
    externalTgwId String
    externalTgwOwner String
    externalTgwRegion String
    name String
    Name of the SDDC Group.
    sddcGroupId String
    tgwId String
    tgwRegion String
    timeouts Property Map
    vpcAttachmentStatus String
    vpcAttachments List<Property Map>
    vpcAwsAccount String
    vpcRamShareId String

    Outputs

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

    Creator string
    Deleted bool
    Id string
    The provider-assigned unique ID for this managed resource.
    OrgId string
    Timestamp string
    Creator string
    Deleted bool
    Id string
    The provider-assigned unique ID for this managed resource.
    OrgId string
    Timestamp string
    creator String
    deleted Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    orgId String
    timestamp String
    creator string
    deleted boolean
    id string
    The provider-assigned unique ID for this managed resource.
    orgId string
    timestamp string
    creator str
    deleted bool
    id str
    The provider-assigned unique ID for this managed resource.
    org_id str
    timestamp str
    creator String
    deleted Boolean
    id String
    The provider-assigned unique ID for this managed resource.
    orgId String
    timestamp String

    Look up Existing SddcGroup Resource

    Get an existing SddcGroup 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?: SddcGroupState, opts?: CustomResourceOptions): SddcGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            creator: Optional[str] = None,
            deleted: Optional[bool] = None,
            description: Optional[str] = None,
            dxgw_allowed_prefixes: Optional[str] = None,
            dxgw_id: Optional[str] = None,
            dxgw_owner: Optional[str] = None,
            dxgw_status: Optional[str] = None,
            external_tgw_configured_prefixes: Optional[str] = None,
            external_tgw_id: Optional[str] = None,
            external_tgw_owner: Optional[str] = None,
            external_tgw_region: Optional[str] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            sddc_group_id: Optional[str] = None,
            sddc_member_ids: Optional[Sequence[str]] = None,
            tgw_id: Optional[str] = None,
            tgw_region: Optional[str] = None,
            timeouts: Optional[SddcGroupTimeoutsArgs] = None,
            timestamp: Optional[str] = None,
            vpc_attachment_status: Optional[str] = None,
            vpc_attachments: Optional[Sequence[SddcGroupVpcAttachmentArgs]] = None,
            vpc_aws_account: Optional[str] = None,
            vpc_ram_share_id: Optional[str] = None) -> SddcGroup
    func GetSddcGroup(ctx *Context, name string, id IDInput, state *SddcGroupState, opts ...ResourceOption) (*SddcGroup, error)
    public static SddcGroup Get(string name, Input<string> id, SddcGroupState? state, CustomResourceOptions? opts = null)
    public static SddcGroup get(String name, Output<String> id, SddcGroupState state, CustomResourceOptions options)
    resources:  _:    type: vmc:SddcGroup    get:      id: ${id}
    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:
    Creator string
    Deleted bool
    Description string
    Short description of the SDDC Group.
    DxgwAllowedPrefixes string
    DxgwId string
    DxgwOwner string
    DxgwStatus string
    ExternalTgwConfiguredPrefixes string
    ExternalTgwId string
    ExternalTgwOwner string
    ExternalTgwRegion string
    Name string
    Name of the SDDC Group.
    OrgId string
    SddcGroupId string
    SddcMemberIds List<string>
    IDs of the SDDCs to be included as members in the SDDC Group.
    TgwId string
    TgwRegion string
    Timeouts SddcGroupTimeouts
    Timestamp string
    VpcAttachmentStatus string
    VpcAttachments List<SddcGroupVpcAttachment>
    VpcAwsAccount string
    VpcRamShareId string
    Creator string
    Deleted bool
    Description string
    Short description of the SDDC Group.
    DxgwAllowedPrefixes string
    DxgwId string
    DxgwOwner string
    DxgwStatus string
    ExternalTgwConfiguredPrefixes string
    ExternalTgwId string
    ExternalTgwOwner string
    ExternalTgwRegion string
    Name string
    Name of the SDDC Group.
    OrgId string
    SddcGroupId string
    SddcMemberIds []string
    IDs of the SDDCs to be included as members in the SDDC Group.
    TgwId string
    TgwRegion string
    Timeouts SddcGroupTimeoutsArgs
    Timestamp string
    VpcAttachmentStatus string
    VpcAttachments []SddcGroupVpcAttachmentArgs
    VpcAwsAccount string
    VpcRamShareId string
    creator String
    deleted Boolean
    description String
    Short description of the SDDC Group.
    dxgwAllowedPrefixes String
    dxgwId String
    dxgwOwner String
    dxgwStatus String
    externalTgwConfiguredPrefixes String
    externalTgwId String
    externalTgwOwner String
    externalTgwRegion String
    name String
    Name of the SDDC Group.
    orgId String
    sddcGroupId String
    sddcMemberIds List<String>
    IDs of the SDDCs to be included as members in the SDDC Group.
    tgwId String
    tgwRegion String
    timeouts SddcGroupTimeouts
    timestamp String
    vpcAttachmentStatus String
    vpcAttachments List<SddcGroupVpcAttachment>
    vpcAwsAccount String
    vpcRamShareId String
    creator string
    deleted boolean
    description string
    Short description of the SDDC Group.
    dxgwAllowedPrefixes string
    dxgwId string
    dxgwOwner string
    dxgwStatus string
    externalTgwConfiguredPrefixes string
    externalTgwId string
    externalTgwOwner string
    externalTgwRegion string
    name string
    Name of the SDDC Group.
    orgId string
    sddcGroupId string
    sddcMemberIds string[]
    IDs of the SDDCs to be included as members in the SDDC Group.
    tgwId string
    tgwRegion string
    timeouts SddcGroupTimeouts
    timestamp string
    vpcAttachmentStatus string
    vpcAttachments SddcGroupVpcAttachment[]
    vpcAwsAccount string
    vpcRamShareId string
    creator String
    deleted Boolean
    description String
    Short description of the SDDC Group.
    dxgwAllowedPrefixes String
    dxgwId String
    dxgwOwner String
    dxgwStatus String
    externalTgwConfiguredPrefixes String
    externalTgwId String
    externalTgwOwner String
    externalTgwRegion String
    name String
    Name of the SDDC Group.
    orgId String
    sddcGroupId String
    sddcMemberIds List<String>
    IDs of the SDDCs to be included as members in the SDDC Group.
    tgwId String
    tgwRegion String
    timeouts Property Map
    timestamp String
    vpcAttachmentStatus String
    vpcAttachments List<Property Map>
    vpcAwsAccount String
    vpcRamShareId String

    Supporting Types

    SddcGroupTimeouts, SddcGroupTimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    SddcGroupVpcAttachment, SddcGroupVpcAttachmentArgs

    AttachId string
    ConfiguredPrefixes string
    State string
    VpcId string
    AttachId string
    ConfiguredPrefixes string
    State string
    VpcId string
    attachId String
    configuredPrefixes String
    state String
    vpcId String
    attachId string
    configuredPrefixes string
    state string
    vpcId string
    attachId String
    configuredPrefixes String
    state String
    vpcId String

    Package Details

    Repository
    vmc vmware/terraform-provider-vmc
    License
    Notes
    This Pulumi package is based on the vmc Terraform Provider.
    vmc logo
    vmc 1.15.4 published on Monday, Apr 21, 2025 by vmware