Package software.amazon.awscdk.services.apigateway

Class CfnAccount

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.apigateway.CfnAccount
All Implemented Interfaces:
IEnvironmentAware, IInspectable, IAccountRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:33.267Z") @Stability(Stable) public class CfnAccount extends CfnResource implements IInspectable, IAccountRef
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.

When you delete a stack containing this resource, API Gateway can still assume the provided IAM role to write API logs to CloudWatch Logs. To deny API Gateway access to write API logs to CloudWatch logs, update the permissions policies or change the IAM role to deny access.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 CfnAccount cfnAccount = CfnAccount.Builder.create(this, "MyCfnAccount")
         .cloudWatchRoleArn("cloudWatchRoleArn")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAccount

      protected CfnAccount(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAccount

      protected CfnAccount(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAccount

      @Stability(Stable) public CfnAccount(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnAccountProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnAccount

      @Stability(Stable) public CfnAccount(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAccountRef

      @Stability(Stable) @NotNull public AccountReference getAccountRef()
      A reference to a Account resource.
      Specified by:
      getAccountRef in interface IAccountRef

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID for the account.

      For example: abc123 .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCloudWatchRoleArn

      @Stability(Stable) @Nullable public String getCloudWatchRoleArn()
      The ARN of an Amazon CloudWatch role for the current Account.

    • setCloudWatchRoleArn

      @Stability(Stable) public void setCloudWatchRoleArn(@Nullable String value)
      The ARN of an Amazon CloudWatch role for the current Account.