Package software.amazon.awscdk.services.vpclattice

Interface CfnResourceConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnResourceConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-14T03:25:06.738Z")
@Stability(Stable)
public interface CfnResourceConfigurationProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnResourceConfiguration.

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.*;
 CfnResourceConfigurationProps cfnResourceConfigurationProps = CfnResourceConfigurationProps.builder()
         .allowAssociationToSharableServiceNetwork(false)
         .name("name")
         .portRanges(List.of("portRanges"))
         .protocolType("protocolType")
         .resourceConfigurationAuthType("resourceConfigurationAuthType")
         .resourceConfigurationDefinition(ResourceConfigurationDefinitionProperty.builder()
                 .arnResource("arnResource")
                 .dnsResource(DnsResourceProperty.builder()
                         .domainName("domainName")
                         .ipAddressType("ipAddressType")
                         .build())
                 .ipResource("ipResource")
                 .build())
         .resourceConfigurationGroupId("resourceConfigurationGroupId")
         .resourceConfigurationType("resourceConfigurationType")
         .resourceGatewayId("resourceGatewayId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnResourceConfigurationProps.Builder	builder()
default Object	getAllowAssociationToSharableServiceNetwork()	Specifies whether the resource configuration can be associated with a sharable service network.
default String	getName()	The name of the resource configuration.
default List<String>	getPortRanges()	(SINGLE, GROUP, CHILD) The TCP port ranges that a consumer can use to access a resource configuration (for example: 1-65535).
default String	getProtocolType()	(SINGLE, GROUP) The protocol accepted by the resource configuration.
default String	getResourceConfigurationAuthType()	The auth type for the resource configuration.
default Object	getResourceConfigurationDefinition()	Identifies the resource configuration in one of the following ways:.
default String	getResourceConfigurationGroupId()	The ID of the group resource configuration.
default String	getResourceConfigurationType()	The type of resource configuration.
default String	getResourceGatewayId()	The ID of the resource gateway.
default List<CfnTag>	getTags()	The tags for the resource configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowAssociationToSharableServiceNetwork

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

Specifies whether the resource configuration can be associated with a sharable service network.

See Also:

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

getName

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

The name of the resource configuration.

See Also:

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

getPortRanges

@Stability(Stable)
@Nullable
default List<String> getPortRanges()

(SINGLE, GROUP, CHILD) The TCP port ranges that a consumer can use to access a resource configuration (for example: 1-65535).

You can separate port ranges using commas (for example: 1,2,22-30).

See Also:

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

getProtocolType

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

(SINGLE, GROUP) The protocol accepted by the resource configuration.

See Also:

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

getResourceConfigurationAuthType

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

The auth type for the resource configuration.

See Also:

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

getResourceConfigurationDefinition

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

Identifies the resource configuration in one of the following ways:.

• Amazon Resource Name (ARN) - Supported resource-types that are provisioned by AWS services, such as RDS databases, can be identified by their ARN.
• Domain name - Any domain name that is publicly resolvable.
• IP address - For IPv4 and IPv6, only IP addresses in the VPC are supported.

See Also:

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

getResourceConfigurationGroupId

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

The ID of the group resource configuration.

See Also:

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

getResourceConfigurationType

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

The type of resource configuration. A resource configuration can be one of the following types:.

• SINGLE - A single resource.
• GROUP - A group of resources. You must create a group resource configuration before you create a child resource configuration.
• CHILD - A single resource that is part of a group resource configuration.
• ARN - An AWS resource.

See Also:

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

getResourceGatewayId

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

The ID of the resource gateway.

See Also:

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

getTags

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

The tags for the resource configuration.

See Also:

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

builder

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

Returns:

a CfnResourceConfigurationProps.Builder of CfnResourceConfigurationProps