Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. networkmanager
  5. SiteToSiteVpnAttachment
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.networkmanager.SiteToSiteVpnAttachment

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS Network Manager SiteToSiteAttachment.

    Example Usage

    Basic Usage

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

const example = new aws.networkmanager.SiteToSiteVpnAttachment("example", {
    coreNetworkId: exampleAwsccNetworkmanagerCoreNetwork.id,
    vpnConnectionArn: exampleAwsVpnConnection.arn,
});

    import pulumi
import pulumi_aws as aws

example = aws.networkmanager.SiteToSiteVpnAttachment("example",
    core_network_id=example_awscc_networkmanager_core_network["id"],
    vpn_connection_arn=example_aws_vpn_connection["arn"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkmanager.NewSiteToSiteVpnAttachment(ctx, "example", &networkmanager.SiteToSiteVpnAttachmentArgs{
			CoreNetworkId:    pulumi.Any(exampleAwsccNetworkmanagerCoreNetwork.Id),
			VpnConnectionArn: pulumi.Any(exampleAwsVpnConnection.Arn),
		})
		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.NetworkManager.SiteToSiteVpnAttachment("example", new()
    {
        CoreNetworkId = exampleAwsccNetworkmanagerCoreNetwork.Id,
        VpnConnectionArn = exampleAwsVpnConnection.Arn,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkmanager.SiteToSiteVpnAttachment;
import com.pulumi.aws.networkmanager.SiteToSiteVpnAttachmentArgs;
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 SiteToSiteVpnAttachment("example", SiteToSiteVpnAttachmentArgs.builder()
            .coreNetworkId(exampleAwsccNetworkmanagerCoreNetwork.id())
            .vpnConnectionArn(exampleAwsVpnConnection.arn())
            .build());

    }
}

    resources:
  example:
    type: aws:networkmanager:SiteToSiteVpnAttachment
    properties:
      coreNetworkId: ${exampleAwsccNetworkmanagerCoreNetwork.id}
      vpnConnectionArn: ${exampleAwsVpnConnection.arn}

    Create SiteToSiteVpnAttachment Resource

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

    Constructor syntax

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

@overload
def SiteToSiteVpnAttachment(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            core_network_id: Optional[str] = None,
                            vpn_connection_arn: Optional[str] = None,
                            tags: Optional[Mapping[str, str]] = None)
    func NewSiteToSiteVpnAttachment(ctx *Context, name string, args SiteToSiteVpnAttachmentArgs, opts ...ResourceOption) (*SiteToSiteVpnAttachment, error)
    public SiteToSiteVpnAttachment(string name, SiteToSiteVpnAttachmentArgs args, CustomResourceOptions? opts = null)
    public SiteToSiteVpnAttachment(String name, SiteToSiteVpnAttachmentArgs args)
public SiteToSiteVpnAttachment(String name, SiteToSiteVpnAttachmentArgs args, CustomResourceOptions options)

    type: aws:networkmanager:SiteToSiteVpnAttachment
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 SiteToSiteVpnAttachmentArgs
    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 SiteToSiteVpnAttachmentArgs
    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 SiteToSiteVpnAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SiteToSiteVpnAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SiteToSiteVpnAttachmentArgs
    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 siteToSiteVpnAttachmentResource = new Aws.NetworkManager.SiteToSiteVpnAttachment("siteToSiteVpnAttachmentResource", new()
{
    CoreNetworkId = "string",
    VpnConnectionArn = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := networkmanager.NewSiteToSiteVpnAttachment(ctx, "siteToSiteVpnAttachmentResource", &networkmanager.SiteToSiteVpnAttachmentArgs{
	CoreNetworkId:    pulumi.String("string"),
	VpnConnectionArn: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var siteToSiteVpnAttachmentResource = new SiteToSiteVpnAttachment("siteToSiteVpnAttachmentResource", SiteToSiteVpnAttachmentArgs.builder()
    .coreNetworkId("string")
    .vpnConnectionArn("string")
    .tags(Map.of("string", "string"))
    .build());

    site_to_site_vpn_attachment_resource = aws.networkmanager.SiteToSiteVpnAttachment("siteToSiteVpnAttachmentResource",
    core_network_id="string",
    vpn_connection_arn="string",
    tags={
        "string": "string",
    })

    const siteToSiteVpnAttachmentResource = new aws.networkmanager.SiteToSiteVpnAttachment("siteToSiteVpnAttachmentResource", {
    coreNetworkId: "string",
    vpnConnectionArn: "string",
    tags: {
        string: "string",
    },
});

    type: aws:networkmanager:SiteToSiteVpnAttachment
properties:
    coreNetworkId: string
    tags:
        string: string
    vpnConnectionArn: string

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

    CoreNetworkId string
    The ID of a core network for the VPN attachment.
    VpnConnectionArn string

    The ARN of the site-to-site VPN connection.

    The following arguments are optional:

    Tags Dictionary<string, string>
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    CoreNetworkId string
    The ID of a core network for the VPN attachment.
    VpnConnectionArn string

    The ARN of the site-to-site VPN connection.

    The following arguments are optional:

    Tags map[string]string
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    coreNetworkId String
    The ID of a core network for the VPN attachment.
    vpnConnectionArn String

    The ARN of the site-to-site VPN connection.

    The following arguments are optional:

    tags Map<String,String>
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    coreNetworkId string
    The ID of a core network for the VPN attachment.
    vpnConnectionArn string

    The ARN of the site-to-site VPN connection.

    The following arguments are optional:

    tags {[key: string]: string}
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    core_network_id str
    The ID of a core network for the VPN attachment.
    vpn_connection_arn str

    The ARN of the site-to-site VPN connection.

    The following arguments are optional:

    tags Mapping[str, str]
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    coreNetworkId String
    The ID of a core network for the VPN attachment.
    vpnConnectionArn String

    The ARN of the site-to-site VPN connection.

    The following arguments are optional:

    tags Map<String>
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    The ARN of the attachment.
    AttachmentPolicyRuleNumber int
    The policy rule number associated with the attachment.
    AttachmentType string
    The type of attachment.
    CoreNetworkArn string
    The ARN of a core network.
    EdgeLocation string
    The Region where the edge is located.
    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerAccountId string
    The ID of the attachment account owner.
    ResourceArn string
    The attachment resource ARN.
    SegmentName string
    The name of the segment attachment.
    State string
    The state of the attachment.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the attachment.
    AttachmentPolicyRuleNumber int
    The policy rule number associated with the attachment.
    AttachmentType string
    The type of attachment.
    CoreNetworkArn string
    The ARN of a core network.
    EdgeLocation string
    The Region where the edge is located.
    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerAccountId string
    The ID of the attachment account owner.
    ResourceArn string
    The attachment resource ARN.
    SegmentName string
    The name of the segment attachment.
    State string
    The state of the attachment.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the attachment.
    attachmentPolicyRuleNumber Integer
    The policy rule number associated with the attachment.
    attachmentType String
    The type of attachment.
    coreNetworkArn String
    The ARN of a core network.
    edgeLocation String
    The Region where the edge is located.
    id String
    The provider-assigned unique ID for this managed resource.
    ownerAccountId String
    The ID of the attachment account owner.
    resourceArn String
    The attachment resource ARN.
    segmentName String
    The name of the segment attachment.
    state String
    The state of the attachment.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the attachment.
    attachmentPolicyRuleNumber number
    The policy rule number associated with the attachment.
    attachmentType string
    The type of attachment.
    coreNetworkArn string
    The ARN of a core network.
    edgeLocation string
    The Region where the edge is located.
    id string
    The provider-assigned unique ID for this managed resource.
    ownerAccountId string
    The ID of the attachment account owner.
    resourceArn string
    The attachment resource ARN.
    segmentName string
    The name of the segment attachment.
    state string
    The state of the attachment.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the attachment.
    attachment_policy_rule_number int
    The policy rule number associated with the attachment.
    attachment_type str
    The type of attachment.
    core_network_arn str
    The ARN of a core network.
    edge_location str
    The Region where the edge is located.
    id str
    The provider-assigned unique ID for this managed resource.
    owner_account_id str
    The ID of the attachment account owner.
    resource_arn str
    The attachment resource ARN.
    segment_name str
    The name of the segment attachment.
    state str
    The state of the attachment.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the attachment.
    attachmentPolicyRuleNumber Number
    The policy rule number associated with the attachment.
    attachmentType String
    The type of attachment.
    coreNetworkArn String
    The ARN of a core network.
    edgeLocation String
    The Region where the edge is located.
    id String
    The provider-assigned unique ID for this managed resource.
    ownerAccountId String
    The ID of the attachment account owner.
    resourceArn String
    The attachment resource ARN.
    segmentName String
    The name of the segment attachment.
    state String
    The state of the attachment.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing SiteToSiteVpnAttachment Resource

    Get an existing SiteToSiteVpnAttachment 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?: SiteToSiteVpnAttachmentState, opts?: CustomResourceOptions): SiteToSiteVpnAttachment
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        attachment_policy_rule_number: Optional[int] = None,
        attachment_type: Optional[str] = None,
        core_network_arn: Optional[str] = None,
        core_network_id: Optional[str] = None,
        edge_location: Optional[str] = None,
        owner_account_id: Optional[str] = None,
        resource_arn: Optional[str] = None,
        segment_name: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpn_connection_arn: Optional[str] = None) -> SiteToSiteVpnAttachment
    func GetSiteToSiteVpnAttachment(ctx *Context, name string, id IDInput, state *SiteToSiteVpnAttachmentState, opts ...ResourceOption) (*SiteToSiteVpnAttachment, error)
    public static SiteToSiteVpnAttachment Get(string name, Input<string> id, SiteToSiteVpnAttachmentState? state, CustomResourceOptions? opts = null)
    public static SiteToSiteVpnAttachment get(String name, Output<String> id, SiteToSiteVpnAttachmentState 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:
    Arn string
    The ARN of the attachment.
    AttachmentPolicyRuleNumber int
    The policy rule number associated with the attachment.
    AttachmentType string
    The type of attachment.
    CoreNetworkArn string
    The ARN of a core network.
    CoreNetworkId string
    The ID of a core network for the VPN attachment.
    EdgeLocation string
    The Region where the edge is located.
    OwnerAccountId string
    The ID of the attachment account owner.
    ResourceArn string
    The attachment resource ARN.
    SegmentName string
    The name of the segment attachment.
    State string
    The state of the attachment.
    Tags Dictionary<string, string>
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VpnConnectionArn string

    The ARN of the site-to-site VPN connection.

    The following arguments are optional:

    Arn string
    The ARN of the attachment.
    AttachmentPolicyRuleNumber int
    The policy rule number associated with the attachment.
    AttachmentType string
    The type of attachment.
    CoreNetworkArn string
    The ARN of a core network.
    CoreNetworkId string
    The ID of a core network for the VPN attachment.
    EdgeLocation string
    The Region where the edge is located.
    OwnerAccountId string
    The ID of the attachment account owner.
    ResourceArn string
    The attachment resource ARN.
    SegmentName string
    The name of the segment attachment.
    State string
    The state of the attachment.
    Tags map[string]string
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    VpnConnectionArn string

    The ARN of the site-to-site VPN connection.

    The following arguments are optional:

    arn String
    The ARN of the attachment.
    attachmentPolicyRuleNumber Integer
    The policy rule number associated with the attachment.
    attachmentType String
    The type of attachment.
    coreNetworkArn String
    The ARN of a core network.
    coreNetworkId String
    The ID of a core network for the VPN attachment.
    edgeLocation String
    The Region where the edge is located.
    ownerAccountId String
    The ID of the attachment account owner.
    resourceArn String
    The attachment resource ARN.
    segmentName String
    The name of the segment attachment.
    state String
    The state of the attachment.
    tags Map<String,String>
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpnConnectionArn String

    The ARN of the site-to-site VPN connection.

    The following arguments are optional:

    arn string
    The ARN of the attachment.
    attachmentPolicyRuleNumber number
    The policy rule number associated with the attachment.
    attachmentType string
    The type of attachment.
    coreNetworkArn string
    The ARN of a core network.
    coreNetworkId string
    The ID of a core network for the VPN attachment.
    edgeLocation string
    The Region where the edge is located.
    ownerAccountId string
    The ID of the attachment account owner.
    resourceArn string
    The attachment resource ARN.
    segmentName string
    The name of the segment attachment.
    state string
    The state of the attachment.
    tags {[key: string]: string}
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpnConnectionArn string

    The ARN of the site-to-site VPN connection.

    The following arguments are optional:

    arn str
    The ARN of the attachment.
    attachment_policy_rule_number int
    The policy rule number associated with the attachment.
    attachment_type str
    The type of attachment.
    core_network_arn str
    The ARN of a core network.
    core_network_id str
    The ID of a core network for the VPN attachment.
    edge_location str
    The Region where the edge is located.
    owner_account_id str
    The ID of the attachment account owner.
    resource_arn str
    The attachment resource ARN.
    segment_name str
    The name of the segment attachment.
    state str
    The state of the attachment.
    tags Mapping[str, str]
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpn_connection_arn str

    The ARN of the site-to-site VPN connection.

    The following arguments are optional:

    arn String
    The ARN of the attachment.
    attachmentPolicyRuleNumber Number
    The policy rule number associated with the attachment.
    attachmentType String
    The type of attachment.
    coreNetworkArn String
    The ARN of a core network.
    coreNetworkId String
    The ID of a core network for the VPN attachment.
    edgeLocation String
    The Region where the edge is located.
    ownerAccountId String
    The ID of the attachment account owner.
    resourceArn String
    The attachment resource ARN.
    segmentName String
    The name of the segment attachment.
    state String
    The state of the attachment.
    tags Map<String>
    Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    vpnConnectionArn String

    The ARN of the site-to-site VPN connection.

    The following arguments are optional:

    Import

    Using pulumi import, import aws_networkmanager_site_to_site_vpn_attachment using the attachment ID. For example:

    $ pulumi import aws:networkmanager/siteToSiteVpnAttachment:SiteToSiteVpnAttachment example attachment-0f8fa60d2238d1bd8

    To learn more about importing existing cloud resources, see Importing resources.

    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
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws