Package software.amazon.awscdk.services.apigateway

Class CfnResource

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.apigateway.CfnResource
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:44.858Z") @Stability(Stable) public class CfnResource extends CfnResource implements IInspectable
A CloudFormation AWS::ApiGateway::Resource.

The AWS::ApiGateway::Resource resource creates a resource in an API.

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.apigateway.*;
 CfnResource cfnResource = CfnResource.Builder.create(this, "MyCfnResource")
         .parentId("parentId")
         .pathPart("pathPart")
         .restApiId("restApiId")
         .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

    • CfnResource

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

    • CfnResource

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

    • CfnResource

      @Stability(Stable) public CfnResource(@NotNull Construct scope, @NotNull String id, @NotNull CfnResourceProps props)
      Create a new AWS::ApiGateway::Resource.

      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.

    • getAttrResourceId

      @Stability(Stable) @NotNull public String getAttrResourceId()
      The ID for the resource.

      For example: abc123 .

    • getCfnProperties

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

    • getParentId

      @Stability(Stable) @NotNull public String getParentId()
      The parent resource's identifier.

    • setParentId

      @Stability(Stable) public void setParentId(@NotNull String value)
      The parent resource's identifier.

    • getPathPart

      @Stability(Stable) @NotNull public String getPathPart()
      The last path segment for this resource.

    • setPathPart

      @Stability(Stable) public void setPathPart(@NotNull String value)
      The last path segment for this resource.

    • getRestApiId

      @Stability(Stable) @NotNull public String getRestApiId()
      The string identifier of the associated RestApi.

    • setRestApiId

      @Stability(Stable) public void setRestApiId(@NotNull String value)
      The string identifier of the associated RestApi.