Class Account

Provides a settings of an API Gateway Account. Settings is applied region-wide per provider block.

Note: As there is no API method for deleting account settings or resetting it to defaults, destroying this resource will keep your account settings intact

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var cloudwatchRole = new Aws.Iam.Role("cloudwatchRole", new Aws.Iam.RoleArgs
    {
        AssumeRolePolicy = @"{
""Version"": ""2012-10-17"",
""Statement"": [
{
  ""Sid"": """",
  ""Effect"": ""Allow"",
  ""Principal"": {
    ""Service"": ""apigateway.amazonaws.com""
  },
  ""Action"": ""sts:AssumeRole""
}
]
}

",
    });
    var demo = new Aws.ApiGateway.Account("demo", new Aws.ApiGateway.AccountArgs
    {
        CloudwatchRoleArn = cloudwatchRole.Arn,
    });
    var cloudwatchRolePolicy = new Aws.Iam.RolePolicy("cloudwatchRolePolicy", new Aws.Iam.RolePolicyArgs
    {
        Policy = @"{
""Version"": ""2012-10-17"",
""Statement"": [
    {
        ""Effect"": ""Allow"",
        ""Action"": [
            ""logs:CreateLogGroup"",
            ""logs:CreateLogStream"",
            ""logs:DescribeLogGroups"",
            ""logs:DescribeLogStreams"",
            ""logs:PutLogEvents"",
            ""logs:GetLogEvents"",
            ""logs:FilterLogEvents""
        ],
        ""Resource"": ""*""
    }
]
}

",
        Role = cloudwatchRole.Id,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Account

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.ApiGateway

Assembly: Pulumi.Aws.dll

Syntax

public class Account : CustomResource

Constructors

Account(String, AccountArgs, CustomResourceOptions)

Create a Account resource with the given unique name, arguments, and options.

Declaration

public Account(string name, AccountArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
AccountArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

CloudwatchRoleArn

The ARN of an IAM role for CloudWatch (to allow logging & monitoring). See more in AWS Docs. Logging & monitoring can be enabled/disabled and otherwise tuned on the API Gateway Stage level.

Declaration

public Output<string> CloudwatchRoleArn { get; }

Property Value

Type	Description
Output<System.String>

ThrottleSettings

Account-Level throttle settings. See exported fields below.

Declaration

public Output<AccountThrottleSettings> ThrottleSettings { get; }

Property Value

Type	Description
Output<AccountThrottleSettings>

Methods

Get(String, Input<String>, AccountState, CustomResourceOptions)

Get an existing Account resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Account Get(string name, Input<string> id, AccountState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
AccountState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Account