Package software.amazon.awscdk.services.vpclattice

Class CfnResourceConfiguration

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.CfnResourceConfiguration
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IResourceConfigurationRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:31.311Z") @Stability(Stable) public class CfnResourceConfiguration extends CfnResource implements IInspectable, IResourceConfigurationRef, ITaggableV2
Creates a resource configuration.

A resource configuration defines a specific resource. You can associate a resource configuration with a service network or a VPC endpoint.

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.*;
 CfnResourceConfiguration cfnResourceConfiguration = CfnResourceConfiguration.Builder.create(this, "MyCfnResourceConfiguration")
         .name("name")
         .resourceConfigurationType("resourceConfigurationType")
         // the properties below are optional
         .allowAssociationToSharableServiceNetwork(false)
         .customDomainName("customDomainName")
         .domainVerificationId("domainVerificationId")
         .groupDomain("groupDomain")
         .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")
         .resourceGatewayId("resourceGatewayId")
         .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

    • CfnResourceConfiguration

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

    • CfnResourceConfiguration

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

    • CfnResourceConfiguration

      @Stability(Stable) public CfnResourceConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnResourceConfigurationProps props)
      Create a new AWS::VpcLattice::ResourceConfiguration.

      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

    • arnForResourceConfiguration

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

    • isCfnResourceConfiguration

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

      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 resource configuration.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the resource configuration.

    • getCdkTagManager

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

    • getCfnProperties

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

    • getResourceConfigurationRef

      @Stability(Stable) @NotNull public ResourceConfigurationReference getResourceConfigurationRef()
      A reference to a ResourceConfiguration resource.
      Specified by:
      getResourceConfigurationRef in interface IResourceConfigurationRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the resource configuration.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the resource configuration.

    • getResourceConfigurationType

      @Stability(Stable) @NotNull public String getResourceConfigurationType()
      The type of resource configuration.

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

    • setResourceConfigurationType

      @Stability(Stable) public void setResourceConfigurationType(@NotNull String value)
      The type of resource configuration.

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

    • getAllowAssociationToSharableServiceNetwork

      @Stability(Stable) @Nullable public Object getAllowAssociationToSharableServiceNetwork()
      Specifies whether the resource configuration can be associated with a sharable service network.

      Returns union: either Boolean or IResolvable

    • setAllowAssociationToSharableServiceNetwork

      @Stability(Stable) public void setAllowAssociationToSharableServiceNetwork(@Nullable Boolean value)
      Specifies whether the resource configuration can be associated with a sharable service network.

    • setAllowAssociationToSharableServiceNetwork

      @Stability(Stable) public void setAllowAssociationToSharableServiceNetwork(@Nullable IResolvable value)
      Specifies whether the resource configuration can be associated with a sharable service network.

    • getCustomDomainName

      @Stability(Stable) @Nullable public String getCustomDomainName()
      The custom domain name.

    • setCustomDomainName

      @Stability(Stable) public void setCustomDomainName(@Nullable String value)
      The custom domain name.

    • getDomainVerificationId

      @Stability(Stable) @Nullable public String getDomainVerificationId()
      The domain verification ID.

    • setDomainVerificationId

      @Stability(Stable) public void setDomainVerificationId(@Nullable String value)
      The domain verification ID.

    • getGroupDomain

      @Stability(Stable) @Nullable public String getGroupDomain()
      (GROUP) The group domain for a group resource configuration.

    • setGroupDomain

      @Stability(Stable) public void setGroupDomain(@Nullable String value)
      (GROUP) The group domain for a group resource configuration.

    • getPortRanges

      @Stability(Stable) @Nullable public List<String> getPortRanges()
      (SINGLE, GROUP, CHILD) The TCP port ranges that a consumer can use to access a resource configuration (for example: 1-65535).

    • setPortRanges

      @Stability(Stable) public void setPortRanges(@Nullable List<String> value)
      (SINGLE, GROUP, CHILD) The TCP port ranges that a consumer can use to access a resource configuration (for example: 1-65535).

    • getProtocolType

      @Stability(Stable) @Nullable public String getProtocolType()
      (SINGLE, GROUP) The protocol accepted by the resource configuration.

    • setProtocolType

      @Stability(Stable) public void setProtocolType(@Nullable String value)
      (SINGLE, GROUP) The protocol accepted by the resource configuration.

    • getResourceConfigurationAuthType

      @Stability(Stable) @Nullable public String getResourceConfigurationAuthType()
      The auth type for the resource configuration.

    • setResourceConfigurationAuthType

      @Stability(Stable) public void setResourceConfigurationAuthType(@Nullable String value)
      The auth type for the resource configuration.

    • getResourceConfigurationDefinition

      @Stability(Stable) @Nullable public Object getResourceConfigurationDefinition()
      Identifies the resource configuration in one of the following ways:.

      Returns union: either IResolvable or CfnResourceConfiguration.ResourceConfigurationDefinitionProperty

    • setResourceConfigurationDefinition

      @Stability(Stable) public void setResourceConfigurationDefinition(@Nullable IResolvable value)
      Identifies the resource configuration in one of the following ways:.

    • setResourceConfigurationDefinition

      @Stability(Stable) public void setResourceConfigurationDefinition(@Nullable CfnResourceConfiguration.ResourceConfigurationDefinitionProperty value)
      Identifies the resource configuration in one of the following ways:.

    • getResourceConfigurationGroupId

      @Stability(Stable) @Nullable public String getResourceConfigurationGroupId()
      The ID of the group resource configuration.

    • setResourceConfigurationGroupId

      @Stability(Stable) public void setResourceConfigurationGroupId(@Nullable String value)
      The ID of the group resource configuration.

    • getResourceGatewayId

      @Stability(Stable) @Nullable public String getResourceGatewayId()
      The ID of the resource gateway.

    • setResourceGatewayId

      @Stability(Stable) public void setResourceGatewayId(@Nullable String value)
      The ID of the resource gateway.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags for the resource configuration.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags for the resource configuration.