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:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.089Z")
 @Stability(value=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.

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnAccount.Builder A fluent builder for CfnAccount.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAccount(software.constructs.Construct scope, String id) Create a new `AWS::ApiGateway::Account`.
	CfnAccount(software.constructs.Construct scope, String id, CfnAccountProps props) Create a new `AWS::ApiGateway::Account`.
protected	CfnAccount(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAccount(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrId() The ID for the account.
protected Map<String,Object>	getCfnProperties()
String	getCloudWatchRoleArn() The Amazon Resource Name (ARN) of an IAM role that has write access to CloudWatch Logs in your account.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCloudWatchRoleArn(String value) The Amazon Resource Name (ARN) of an IAM role that has write access to CloudWatch Logs in your account.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAccount

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

CfnAccount

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

CfnAccount

@Stability(value=Stable)
public CfnAccount(@NotNull
                                           software.constructs.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(value=Stable)
public CfnAccount(@NotNull
                                           software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrId()

The ID for the account.

For example: abc123 .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCloudWatchRoleArn

@Stability(value=Stable)
 @Nullable
public String getCloudWatchRoleArn()

The Amazon Resource Name (ARN) of an IAM role that has write access to CloudWatch Logs in your account.

setCloudWatchRoleArn

@Stability(value=Stable)
public void setCloudWatchRoleArn(@Nullable
                                                          String value)

The Amazon Resource Name (ARN) of an IAM role that has write access to CloudWatch Logs in your account.