Package software.amazon.awscdk.services.vpclattice

Class CfnServiceNetwork

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.vpclattice.CfnServiceNetwork
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IServiceNetworkRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:47.121Z") @Stability(Stable) public class CfnServiceNetwork extends CfnResource implements IInspectable, IServiceNetworkRef, ITaggable
Creates a service network.

A service network is a logical boundary for a collection of services. You can associate services and VPCs with a service network.

For more information, see Service networks in the Amazon VPC Lattice User Guide .

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.vpclattice.*;
 CfnServiceNetwork cfnServiceNetwork = CfnServiceNetwork.Builder.create(this, "MyCfnServiceNetwork")
         .authType("authType")
         .name("name")
         .sharingConfig(SharingConfigProperty.builder()
                 .enabled(false)
                 .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

    • CfnServiceNetwork

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

    • CfnServiceNetwork

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

    • CfnServiceNetwork

      @Stability(Stable) public CfnServiceNetwork(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnServiceNetworkProps props)
      Create a new AWS::VpcLattice::ServiceNetwork.

      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.

    • CfnServiceNetwork

      @Stability(Stable) public CfnServiceNetwork(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::VpcLattice::ServiceNetwork.

      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.

  • Method Details

    • arnForServiceNetwork

      @Stability(Stable) @NotNull public static String arnForServiceNetwork(@NotNull IServiceNetworkRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnServiceNetwork

      @Stability(Stable) @NotNull public static Boolean isCfnServiceNetwork(@NotNull Object x)
      Checks whether the given object is a CfnServiceNetwork.

      Parameters:
      x - This parameter is required.

    • 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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the service network.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The date and time that the service network was created, specified in ISO-8601 format.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the service network.

    • getAttrLastUpdatedAt

      @Stability(Stable) @NotNull public String getAttrLastUpdatedAt()
      The date and time of the last update, specified in ISO-8601 format.

    • getCfnProperties

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

    • getServiceNetworkRef

      @Stability(Stable) @NotNull public ServiceNetworkReference getServiceNetworkRef()
      A reference to a ServiceNetwork resource.
      Specified by:
      getServiceNetworkRef in interface IServiceNetworkRef

    • getTags

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

    • getAuthType

      @Stability(Stable) @Nullable public String getAuthType()
      The type of IAM policy.

    • setAuthType

      @Stability(Stable) public void setAuthType(@Nullable String value)
      The type of IAM policy.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the service network.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the service network.

    • getSharingConfig

      @Stability(Stable) @Nullable public Object getSharingConfig()
      Specify if the service network should be enabled for sharing.

      Returns union: either IResolvable or CfnServiceNetwork.SharingConfigProperty

    • setSharingConfig

      @Stability(Stable) public void setSharingConfig(@Nullable IResolvable value)
      Specify if the service network should be enabled for sharing.

    • setSharingConfig

      @Stability(Stable) public void setSharingConfig(@Nullable CfnServiceNetwork.SharingConfigProperty value)
      Specify if the service network should be enabled for sharing.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags for the service network.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags for the service network.