CfnResourceProps

class aws_cdk.aws_apigateway.CfnResourceProps(*, parent_id, path_part, rest_api_id)

Bases: object

Properties for defining a CfnResource.

Parameters
  • parent_id (str) – 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"] } .

  • path_part (str) – A path name for the resource.

  • rest_api_id (str) – The ID of the RestApi resource in which you want to create this resource.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigateway as apigateway

cfn_resource_props = apigateway.CfnResourceProps(
    parent_id="parentId",
    path_part="pathPart",
    rest_api_id="restApiId"
)

Attributes

parent_id

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-parentid

Return type

str

path_part

A path name for the resource.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-pathpart

Return type

str

rest_api_id

//docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html>`_ resource in which you want to create this resource.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-restapiid

Type

The ID of the `RestApi <https

Return type

str