Table of Contents

Class CfnAccount

Namespace
Amazon.CDK.AWS.APIGateway
Assembly
Amazon.CDK.AWS.APIGateway.dll

A CloudFormation AWS::ApiGateway::Account.

public class CfnAccount : CfnResource, IInspectable
Inheritance
CfnAccount
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 cfnAccount = new CfnAccount(this, "MyCfnAccount", new CfnAccountProps {
                 CloudWatchRoleArn = "cloudWatchRoleArn"
             });

Remarks

The AWS::ApiGateway::Account resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one AWS::ApiGateway::Account resource per region per account.

CloudformationResource: AWS::ApiGateway::Account

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

ExampleMetadata: fixture=_generated

Constructors

CfnAccount(Construct, string, ICfnAccountProps?)

Create a new AWS::ApiGateway::Account.

public CfnAccount(Construct scope, string id, ICfnAccountProps? props = null)

Parameters

scope Construct
  • scope in which this resource is defined.
id string
  • scoped id of the resource.
props ICfnAccountProps
  • resource properties.

Properties

AttrId

The ID for the account.

public virtual string AttrId { get; }

Property Value

string

Remarks

For example: abc123 .

CloudformationAttribute: Id

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>

CloudWatchRoleArn

The ARN of an Amazon CloudWatch role for the current Account.

public virtual string? CloudWatchRoleArn { get; set; }

Property Value

string

Remarks

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>