software.amazon.awscdk.services.apigateway

Class CfnResource.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.CfnResource.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnResource>

Enclosing class:

CfnResource

@Stability(value=Stable)
public static final class CfnResource.Builder
extends Object
implements software.amazon.jsii.Builder<CfnResource>

A fluent builder for CfnResource.

Method Summary

Modifier and Type	Method and Description
CfnResource	build()
static CfnResource.Builder	create(software.constructs.Construct scope, String id)
CfnResource.Builder	parentId(String parentId) If you want to create a child resource, the ID of the parent resource.
CfnResource.Builder	pathPart(String pathPart) A path name for the resource.
CfnResource.Builder	restApiId(String restApiId) 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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnResource.Builder create(software.constructs.Construct scope,
                                                                  String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnResource.Builder.

parentId

@Stability(value=Stable)
public CfnResource.Builder parentId(String parentId)

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"] } .

Parameters:

parentId - If you want to create a child resource, the ID of the parent resource. This parameter is required.

Returns:

this

pathPart

@Stability(value=Stable)
public CfnResource.Builder pathPart(String pathPart)

A path name for the resource.

Parameters:

pathPart - A path name for the resource. This parameter is required.

Returns:

this

restApiId

@Stability(value=Stable)
public CfnResource.Builder restApiId(String restApiId)

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.

Parameters:

restApiId - 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. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnResource build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnResource>