Package software.amazon.awscdk.services.networkmanager

Class CfnVpcAttachment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.networkmanager.CfnVpcAttachment
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.487Z") @Stability(Stable) public class CfnVpcAttachment extends CfnResource implements IInspectable
A CloudFormation AWS::NetworkManager::VpcAttachment.

Creates a VPC 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.*;
 CfnVpcAttachment cfnVpcAttachment = CfnVpcAttachment.Builder.create(this, "MyCfnVpcAttachment")
         .coreNetworkId("coreNetworkId")
         .subnetArns(List.of("subnetArns"))
         .vpcArn("vpcArn")
         // the properties below are optional
         .options(VpcOptionsProperty.builder()
                 .applianceModeSupport(false)
                 .ipv6Support(false)
                 .build())
         .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();

  • 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

    • CfnVpcAttachment

      protected CfnVpcAttachment(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnVpcAttachment

      protected CfnVpcAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnVpcAttachment

      @Stability(Stable) public CfnVpcAttachment(@NotNull Construct scope, @NotNull String id, @NotNull CfnVpcAttachmentProps props)
      Create a new AWS::NetworkManager::VpcAttachment.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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 VPC 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 VPC .

    • getAttrCoreNetworkArn

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

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp when the VPC 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 VPC attachment owner.

    • getAttrResourceArn

      @Stability(Stable) @NotNull public String getAttrResourceArn()
      The resource ARN for the VPC attachment.

    • getAttrSegmentName

      @Stability(Stable) @NotNull public String getAttrSegmentName()
      The name of the attachment's segment.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The state of the 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 VPC 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()
      The tags associated with the VPC attachment.

    • getCoreNetworkId

      @Stability(Stable) @NotNull public String getCoreNetworkId()
      The core network ID.

    • setCoreNetworkId

      @Stability(Stable) public void setCoreNetworkId(@NotNull String value)
      The core network ID.

    • getSubnetArns

      @Stability(Stable) @NotNull public List<String> getSubnetArns()
      The subnet ARNs.

    • setSubnetArns

      @Stability(Stable) public void setSubnetArns(@NotNull List<String> value)
      The subnet ARNs.

    • getVpcArn

      @Stability(Stable) @NotNull public String getVpcArn()
      The ARN of the VPC attachment.

    • setVpcArn

      @Stability(Stable) public void setVpcArn(@NotNull String value)
      The ARN of the VPC attachment.

    • getOptions

      @Stability(Stable) @Nullable public Object getOptions()
      Options for creating the VPC attachment.

    • setOptions

      @Stability(Stable) public void setOptions(@Nullable IResolvable value)
      Options for creating the VPC attachment.

    • setOptions

      @Stability(Stable) public void setOptions(@Nullable CfnVpcAttachment.VpcOptionsProperty value)
      Options for creating the VPC attachment.

    • getProposedSegmentChange

      @Stability(Stable) @Nullable public Object getProposedSegmentChange()
      AWS::NetworkManager::VpcAttachment.ProposedSegmentChange.

    • setProposedSegmentChange

      @Stability(Stable) public void setProposedSegmentChange(@Nullable IResolvable value)
      AWS::NetworkManager::VpcAttachment.ProposedSegmentChange.

    • setProposedSegmentChange

      @Stability(Stable) public void setProposedSegmentChange(@Nullable CfnVpcAttachment.ProposedSegmentChangeProperty value)
      AWS::NetworkManager::VpcAttachment.ProposedSegmentChange.