Package software.amazon.awscdk.services.apigateway

Class CfnAccount

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.apigateway.CfnAccount
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:44.710Z") @Stability(Stable) public class CfnAccount extends CfnResource implements IInspectable
A CloudFormation AWS::ApiGateway::Account.

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.

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();

  • 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 Construct scope, @NotNull String id, @Nullable CfnAccountProps props)
      Create a new AWS::ApiGateway::Account.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnAccount

      @Stability(Stable) public CfnAccount(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::ApiGateway::Account.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

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