Class CfnAccount

A CloudFormation AWS::ApiGateway::Account.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnAccount
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAccount : CfnResource, IInspectable
Syntax (vb)
Public Class CfnAccount
    Inherits CfnResource
    Implements IInspectable
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.

If an API Gateway resource has never been created in your AWS account , you must add a dependency on another API Gateway resource, such as an AWS::ApiGateway::RestApi or AWS::ApiGateway::ApiKey resource.

If an API Gateway resource has been created in your AWS account , no dependency is required (even if the resource was deleted).

CloudformationResource: AWS::ApiGateway::Account

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

ExampleMetadata: fixture=_generated

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"
});

Synopsis

Constructors

CfnAccount(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnAccount(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnAccount(Construct, String, ICfnAccountProps)

Create a new AWS::ApiGateway::Account.

Properties

AttrId

The ID for the account.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
CloudWatchRoleArn

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnAccount(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnAccount(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnAccount(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnAccount(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnAccount(Construct, String, ICfnAccountProps)

Create a new AWS::ApiGateway::Account.

public CfnAccount(Construct scope, string id, ICfnAccountProps props = null)
Parameters
scope Constructs.Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnAccountProps
  • resource properties.

Properties

AttrId

The ID for the account.

public virtual string AttrId { get; }
Property Value

System.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

System.String

CfnProperties

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

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CloudWatchRoleArn

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

public virtual string CloudWatchRoleArn { get; set; }
Property Value

System.String

Remarks

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

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 System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements