Package software.amazon.awscdk.services.vpclattice

Interface CfnServiceNetworkProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServiceNetworkProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-19T18:01:43.862Z")
@Stability(Stable)
public interface CfnServiceNetworkProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnServiceNetwork.

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.*;
 CfnServiceNetworkProps cfnServiceNetworkProps = CfnServiceNetworkProps.builder()
         .authType("authType")
         .name("name")
         .sharingConfig(SharingConfigProperty.builder()
                 .enabled(false)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetwork.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnServiceNetworkProps.Builder	A builder for CfnServiceNetworkProps
static final class	CfnServiceNetworkProps.Jsii$Proxy	An implementation for CfnServiceNetworkProps

Method Summary

Modifier and Type	Method	Description
static CfnServiceNetworkProps.Builder	builder()
default String	getAuthType()	The type of IAM policy.
default String	getName()	The name of the service network.
default Object	getSharingConfig()	Specify if the service network should be enabled for sharing.
default List<CfnTag>	getTags()	The tags for the service network.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthType

@Stability(Stable)
@Nullable
default String getAuthType()

The type of IAM policy.

• NONE : The resource does not use an IAM policy. This is the default.
• AWS_IAM : The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.

Default: - "NONE"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetwork.html#cfn-vpclattice-servicenetwork-authtype

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the service network.

The name must be unique to the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.

If you don't specify a name, CloudFormation generates one. However, if you specify a name, and later want to replace the resource, you must specify a new name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetwork.html#cfn-vpclattice-servicenetwork-name

getSharingConfig

@Stability(Stable)
@Nullable
default Object getSharingConfig()

Specify if the service network should be enabled for sharing.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetwork.html#cfn-vpclattice-servicenetwork-sharingconfig

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags for the service network.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-vpclattice-servicenetwork.html#cfn-vpclattice-servicenetwork-tags

builder

@Stability(Stable)
static CfnServiceNetworkProps.Builder builder()

Returns:

a CfnServiceNetworkProps.Builder of CfnServiceNetworkProps