Class CfnSiteToSiteVpnAttachment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.networkmanager.CfnSiteToSiteVpnAttachment
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:06.011Z") @Stability(Stable) public class CfnSiteToSiteVpnAttachment extends CfnResource implements IInspectable, ITaggable
Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.networkmanager.*;
 CfnSiteToSiteVpnAttachment cfnSiteToSiteVpnAttachment = CfnSiteToSiteVpnAttachment.Builder.create(this, "MyCfnSiteToSiteVpnAttachment")
         .coreNetworkId("coreNetworkId")
         .vpnConnectionArn("vpnConnectionArn")
         // the properties below are optional
         .proposedSegmentChange(ProposedSegmentChangeProperty.builder()
                 .attachmentPolicyRuleNumber(123)
                 .segmentName("segmentName")
                 .tags(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:
  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.
  • Constructor Details

    • CfnSiteToSiteVpnAttachment

      protected CfnSiteToSiteVpnAttachment(software.amazon.jsii.JsiiObjectRef objRef)
    • CfnSiteToSiteVpnAttachment

      protected CfnSiteToSiteVpnAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • CfnSiteToSiteVpnAttachment

      @Stability(Stable) public CfnSiteToSiteVpnAttachment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSiteToSiteVpnAttachmentProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.
  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.
    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.
    • getAttrAttachmentId

      @Stability(Stable) @NotNull public String getAttrAttachmentId()
      The ID of the site-to-site VPN attachment.
    • getAttrAttachmentPolicyRuleNumber

      @Stability(Stable) @NotNull public Number getAttrAttachmentPolicyRuleNumber()
      The policy rule number associated with the attachment.
    • getAttrAttachmentType

      @Stability(Stable) @NotNull public String getAttrAttachmentType()
      The type of attachment.

      This will be SITE_TO_SITE_VPN .

    • getAttrCoreNetworkArn

      @Stability(Stable) @NotNull public String getAttrCoreNetworkArn()
      The ARN of the core network.
    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp when the site-to-site VPN attachment was created.
    • getAttrEdgeLocation

      @Stability(Stable) @NotNull public String getAttrEdgeLocation()
      The Region where the core network edge is located.
    • getAttrOwnerAccountId

      @Stability(Stable) @NotNull public String getAttrOwnerAccountId()
      The ID of the site-to-site VPN attachment owner.
    • getAttrResourceArn

      @Stability(Stable) @NotNull public String getAttrResourceArn()
      The resource ARN for the site-to-site VPN attachment.
    • getAttrSegmentName

      @Stability(Stable) @NotNull public String getAttrSegmentName()
      The name of the site-to-site VPN attachment's segment.
    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The state of the site-to-site VPN attachment.

      This can be: REJECTED | PENDING_ATTACHMENT_ACCEPTANCE | CREATING | FAILED | AVAILABLE | UPDATING | PENDING_NETWORK_UPDATE | PENDING_TAG_ACCEPTANCE | DELETING .

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The timestamp when the site-to-site VPN attachment was last updated.
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable
    • getCoreNetworkId

      @Stability(Stable) @NotNull public String getCoreNetworkId()
      The ID of a core network where you're creating a site-to-site VPN attachment.
    • setCoreNetworkId

      @Stability(Stable) public void setCoreNetworkId(@NotNull String value)
      The ID of a core network where you're creating a site-to-site VPN attachment.
    • getVpnConnectionArn

      @Stability(Stable) @NotNull public String getVpnConnectionArn()
      The ARN of the site-to-site VPN attachment.
    • setVpnConnectionArn

      @Stability(Stable) public void setVpnConnectionArn(@NotNull String value)
      The ARN of the site-to-site VPN attachment.
    • getProposedSegmentChange

      @Stability(Stable) @Nullable public Object getProposedSegmentChange()
      Describes a proposed segment change.
    • setProposedSegmentChange

      @Stability(Stable) public void setProposedSegmentChange(@Nullable IResolvable value)
      Describes a proposed segment change.
    • setProposedSegmentChange

      @Stability(Stable) public void setProposedSegmentChange(@Nullable CfnSiteToSiteVpnAttachment.ProposedSegmentChangeProperty value)
      Describes a proposed segment change.
    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags associated with the Site-to-Site VPN attachment.
    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags associated with the Site-to-Site VPN attachment.