software.amazon.awscdk.services.apigateway

Interface CfnResourceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnResourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.130Z")
 @Stability(value=Stable)
public interface CfnResourceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnResource`.

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.*;
 CfnResourceProps cfnResourceProps = CfnResourceProps.builder()
         .parentId("parentId")
         .pathPart("pathPart")
         .restApiId("restApiId")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnResourceProps.Builder	builder()
String	getParentId() If you want to create a child resource, the ID of the parent resource.
String	getPathPart() A path name for the resource.
String	getRestApiId() The ID of the [RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource in which you want to create this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getParentId

@Stability(value=Stable)
 @NotNull
String getParentId()

If you want to create a child resource, the ID of the parent resource.

For resources without a parent, specify the RestApi root resource ID, such as { "Fn::GetAtt": ["MyRestApi", "RootResourceId"] } .

getPathPart

@Stability(value=Stable)
 @NotNull
String getPathPart()

A path name for the resource.

getRestApiId

@Stability(value=Stable)
 @NotNull
String getRestApiId()

The ID of the [RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource in which you want to create this resource.

builder

@Stability(value=Stable)
static CfnResourceProps.Builder builder()

Returns:

a CfnResourceProps.Builder of CfnResourceProps