Class CfnResource

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

A CloudFormation AWS::ApiGateway::Resource.

public class CfnResource : CfnResource, IInspectable

Inheritance

object

CfnResource

Implements

IInspectable

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.APIGateway;

             var cfnResource = new CfnResource(this, "MyCfnResource", new CfnResourceProps {
                 ParentId = "parentId",
                 PathPart = "pathPart",
                 RestApiId = "restApiId"
             });

Remarks

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

CloudformationResource: AWS::ApiGateway::Resource

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

ExampleMetadata: fixture=_generated

Constructors

CfnResource(Construct, string, ICfnResourceProps)

Create a new AWS::ApiGateway::Resource.

public CfnResource(Construct scope, string id, ICfnResourceProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id string

• scoped id of the resource.

props ICfnResourceProps

• resource properties.

Properties

AttrResourceId

The ID for the resource.

public virtual string AttrResourceId { get; }

Property Value

string

Remarks

For example: abc123 .

CloudformationAttribute: ResourceId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

ParentId

The parent resource's identifier.

public virtual string ParentId { get; set; }

Property Value

string

Remarks

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

PathPart

The last path segment for this resource.

public virtual string PathPart { get; set; }

Property Value

string

Remarks

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

RestApiId

The string identifier of the associated RestApi.

public virtual string RestApiId { get; set; }

Property Value

string

Remarks

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

• tree inspector to collect and process attributes.

RenderProperties(IDictionary<string, object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>