servicequotas

package
v3.38.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 13, 2021 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetServiceArgs 

type GetServiceArgs struct {
	// Service name to lookup within Service Quotas. Available values can be found with the [AWS CLI service-quotas list-services command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-services.html).
	ServiceName string `pulumi:"serviceName"`
}

A collection of arguments for invoking getService.

type GetServiceResult 

type GetServiceResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// Code of the service.
	ServiceCode string `pulumi:"serviceCode"`
	ServiceName string `pulumi:"serviceName"`
}

A collection of values returned by getService.

func GetService 

func GetService(ctx *pulumi.Context, args *GetServiceArgs, opts ...pulumi.InvokeOption) (*GetServiceResult, error)

Retrieve information about a Service Quotas Service.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/servicequotas"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := servicequotas.GetService(ctx, &servicequotas.GetServiceArgs{
			ServiceName: "Amazon Virtual Private Cloud (Amazon VPC)",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type LookupServiceQuotaArgs 

type LookupServiceQuotaArgs struct {
	// Quota code within the service. When configured, the data source directly looks up the service quota. Available values can be found with the [AWS CLI service-quotas list-service-quotas command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html).
	QuotaCode *string `pulumi:"quotaCode"`
	// Quota name within the service. When configured, the data source searches through all service quotas to find the matching quota name. Available values can be found with the [AWS CLI service-quotas list-service-quotas command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html).
	QuotaName *string `pulumi:"quotaName"`
	// Service code for the quota. Available values can be found with the `servicequotas.getService` data source or [AWS CLI service-quotas list-services command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-services.html).
	ServiceCode string `pulumi:"serviceCode"`
}

A collection of arguments for invoking getServiceQuota.

type LookupServiceQuotaResult 

type LookupServiceQuotaResult struct {
	// Whether the service quota is adjustable.
	Adjustable bool `pulumi:"adjustable"`
	// Amazon Resource Name (ARN) of the service quota.
	Arn string `pulumi:"arn"`
	// Default value of the service quota.
	DefaultValue float64 `pulumi:"defaultValue"`
	// Whether the service quota is global for the AWS account.
	GlobalQuota bool `pulumi:"globalQuota"`
	// The provider-assigned unique ID for this managed resource.
	Id          string `pulumi:"id"`
	QuotaCode   string `pulumi:"quotaCode"`
	QuotaName   string `pulumi:"quotaName"`
	ServiceCode string `pulumi:"serviceCode"`
	// Name of the service.
	ServiceName string `pulumi:"serviceName"`
	// Current value of the service quota.
	Value float64 `pulumi:"value"`
}

A collection of values returned by getServiceQuota.

func LookupServiceQuota 

func LookupServiceQuota(ctx *pulumi.Context, args *LookupServiceQuotaArgs, opts ...pulumi.InvokeOption) (*LookupServiceQuotaResult, error)

Retrieve information about a Service Quota.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/servicequotas"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		opt0 := "L-F678F1CE"
		_, err := servicequotas.LookupServiceQuota(ctx, &servicequotas.LookupServiceQuotaArgs{
			QuotaCode:   &opt0,
			ServiceCode: "vpc",
		}, nil)
		if err != nil {
			return err
		}
		opt1 := "VPCs per Region"
		_, err = servicequotas.LookupServiceQuota(ctx, &servicequotas.LookupServiceQuotaArgs{
			QuotaName:   &opt1,
			ServiceCode: "vpc",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type ServiceQuota 

type ServiceQuota struct {
	pulumi.CustomResourceState

	// Whether the service quota can be increased.
	Adjustable pulumi.BoolOutput `pulumi:"adjustable"`
	// Amazon Resource Name (ARN) of the service quota.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// Default value of the service quota.
	DefaultValue pulumi.Float64Output `pulumi:"defaultValue"`
	// Code of the service quota to track. For example: `L-F678F1CE`. Available values can be found with the [AWS CLI service-quotas list-service-quotas command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html).
	QuotaCode pulumi.StringOutput `pulumi:"quotaCode"`
	// Name of the quota.
	QuotaName     pulumi.StringOutput `pulumi:"quotaName"`
	RequestId     pulumi.StringOutput `pulumi:"requestId"`
	RequestStatus pulumi.StringOutput `pulumi:"requestStatus"`
	// Code of the service to track. For example: `vpc`. Available values can be found with the [AWS CLI service-quotas list-services command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-services.html).
	ServiceCode pulumi.StringOutput `pulumi:"serviceCode"`
	// Name of the service.
	ServiceName pulumi.StringOutput `pulumi:"serviceName"`
	// Float specifying the desired value for the service quota. If the desired value is higher than the current value, a quota increase request is submitted. When a known request is submitted and pending, the value reflects the desired value of the pending request.
	Value pulumi.Float64Output `pulumi:"value"`
}

Manages an individual Service Quota.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/servicequotas"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := servicequotas.NewServiceQuota(ctx, "example", &servicequotas.ServiceQuotaArgs{
			QuotaCode:   pulumi.String("L-F678F1CE"),
			ServiceCode: pulumi.String("vpc"),
			Value:       pulumi.Float64(75),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

~> *NOTE* This resource does not require explicit import and will assume management of an existing service quota on resource creation. `aws_servicequotas_service_quota` can be imported by using the service code and quota code, separated by a front slash (`/`), e.g.

```sh 

$ pulumi import aws:servicequotas/serviceQuota:ServiceQuota example vpc/L-F678F1CE

```

func GetServiceQuota 

func GetServiceQuota(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ServiceQuotaState, opts ...pulumi.ResourceOption) (*ServiceQuota, error)

GetServiceQuota gets an existing ServiceQuota resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServiceQuota 

func NewServiceQuota(ctx *pulumi.Context,
	name string, args *ServiceQuotaArgs, opts ...pulumi.ResourceOption) (*ServiceQuota, error)

NewServiceQuota registers a new resource with the given unique name, arguments, and options.

func (*ServiceQuota) ElementType added in v3.13.0 

func (*ServiceQuota) ElementType() reflect.Type

func (*ServiceQuota) ToServiceQuotaOutput added in v3.13.0 

func (i *ServiceQuota) ToServiceQuotaOutput() ServiceQuotaOutput

func (*ServiceQuota) ToServiceQuotaOutputWithContext added in v3.13.0 

func (i *ServiceQuota) ToServiceQuotaOutputWithContext(ctx context.Context) ServiceQuotaOutput

func (*ServiceQuota) ToServiceQuotaPtrOutput added in v3.25.0 

func (i *ServiceQuota) ToServiceQuotaPtrOutput() ServiceQuotaPtrOutput

func (*ServiceQuota) ToServiceQuotaPtrOutputWithContext added in v3.25.0 

func (i *ServiceQuota) ToServiceQuotaPtrOutputWithContext(ctx context.Context) ServiceQuotaPtrOutput

type ServiceQuotaArgs 

type ServiceQuotaArgs struct {
	// Code of the service quota to track. For example: `L-F678F1CE`. Available values can be found with the [AWS CLI service-quotas list-service-quotas command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html).
	QuotaCode pulumi.StringInput
	// Code of the service to track. For example: `vpc`. Available values can be found with the [AWS CLI service-quotas list-services command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-services.html).
	ServiceCode pulumi.StringInput
	// Float specifying the desired value for the service quota. If the desired value is higher than the current value, a quota increase request is submitted. When a known request is submitted and pending, the value reflects the desired value of the pending request.
	Value pulumi.Float64Input
}

The set of arguments for constructing a ServiceQuota resource.

func (ServiceQuotaArgs) ElementType 

func (ServiceQuotaArgs) ElementType() reflect.Type

type ServiceQuotaArray added in v3.25.0 

type ServiceQuotaArray []ServiceQuotaInput

func (ServiceQuotaArray) ElementType added in v3.25.0 

func (ServiceQuotaArray) ElementType() reflect.Type

func (ServiceQuotaArray) ToServiceQuotaArrayOutput added in v3.25.0 

func (i ServiceQuotaArray) ToServiceQuotaArrayOutput() ServiceQuotaArrayOutput

func (ServiceQuotaArray) ToServiceQuotaArrayOutputWithContext added in v3.25.0 

func (i ServiceQuotaArray) ToServiceQuotaArrayOutputWithContext(ctx context.Context) ServiceQuotaArrayOutput

type ServiceQuotaArrayInput added in v3.25.0 

type ServiceQuotaArrayInput interface {
	pulumi.Input

	ToServiceQuotaArrayOutput() ServiceQuotaArrayOutput
	ToServiceQuotaArrayOutputWithContext(context.Context) ServiceQuotaArrayOutput
}

ServiceQuotaArrayInput is an input type that accepts ServiceQuotaArray and ServiceQuotaArrayOutput values. You can construct a concrete instance of `ServiceQuotaArrayInput` via: 

ServiceQuotaArray{ ServiceQuotaArgs{...} }

type ServiceQuotaArrayOutput added in v3.25.0 

type ServiceQuotaArrayOutput struct{ *pulumi.OutputState }

func (ServiceQuotaArrayOutput) ElementType added in v3.25.0 

func (ServiceQuotaArrayOutput) ElementType() reflect.Type

func (ServiceQuotaArrayOutput) Index added in v3.25.0 

func (o ServiceQuotaArrayOutput) Index(i pulumi.IntInput) ServiceQuotaOutput

func (ServiceQuotaArrayOutput) ToServiceQuotaArrayOutput added in v3.25.0 

func (o ServiceQuotaArrayOutput) ToServiceQuotaArrayOutput() ServiceQuotaArrayOutput

func (ServiceQuotaArrayOutput) ToServiceQuotaArrayOutputWithContext added in v3.25.0 

func (o ServiceQuotaArrayOutput) ToServiceQuotaArrayOutputWithContext(ctx context.Context) ServiceQuotaArrayOutput

type ServiceQuotaInput added in v3.13.0 

type ServiceQuotaInput interface {
	pulumi.Input

	ToServiceQuotaOutput() ServiceQuotaOutput
	ToServiceQuotaOutputWithContext(ctx context.Context) ServiceQuotaOutput
}

type ServiceQuotaMap added in v3.25.0 

type ServiceQuotaMap map[string]ServiceQuotaInput

func (ServiceQuotaMap) ElementType added in v3.25.0 

func (ServiceQuotaMap) ElementType() reflect.Type

func (ServiceQuotaMap) ToServiceQuotaMapOutput added in v3.25.0 

func (i ServiceQuotaMap) ToServiceQuotaMapOutput() ServiceQuotaMapOutput

func (ServiceQuotaMap) ToServiceQuotaMapOutputWithContext added in v3.25.0 

func (i ServiceQuotaMap) ToServiceQuotaMapOutputWithContext(ctx context.Context) ServiceQuotaMapOutput

type ServiceQuotaMapInput added in v3.25.0 

type ServiceQuotaMapInput interface {
	pulumi.Input

	ToServiceQuotaMapOutput() ServiceQuotaMapOutput
	ToServiceQuotaMapOutputWithContext(context.Context) ServiceQuotaMapOutput
}

ServiceQuotaMapInput is an input type that accepts ServiceQuotaMap and ServiceQuotaMapOutput values. You can construct a concrete instance of `ServiceQuotaMapInput` via: 

ServiceQuotaMap{ "key": ServiceQuotaArgs{...} }

type ServiceQuotaMapOutput added in v3.25.0 

type ServiceQuotaMapOutput struct{ *pulumi.OutputState }

func (ServiceQuotaMapOutput) ElementType added in v3.25.0 

func (ServiceQuotaMapOutput) ElementType() reflect.Type

func (ServiceQuotaMapOutput) MapIndex added in v3.25.0 

func (o ServiceQuotaMapOutput) MapIndex(k pulumi.StringInput) ServiceQuotaOutput

func (ServiceQuotaMapOutput) ToServiceQuotaMapOutput added in v3.25.0 

func (o ServiceQuotaMapOutput) ToServiceQuotaMapOutput() ServiceQuotaMapOutput

func (ServiceQuotaMapOutput) ToServiceQuotaMapOutputWithContext added in v3.25.0 

func (o ServiceQuotaMapOutput) ToServiceQuotaMapOutputWithContext(ctx context.Context) ServiceQuotaMapOutput

type ServiceQuotaOutput added in v3.13.0 

type ServiceQuotaOutput struct {
	*pulumi.OutputState
}

func (ServiceQuotaOutput) ElementType added in v3.13.0 

func (ServiceQuotaOutput) ElementType() reflect.Type

func (ServiceQuotaOutput) ToServiceQuotaOutput added in v3.13.0 

func (o ServiceQuotaOutput) ToServiceQuotaOutput() ServiceQuotaOutput

func (ServiceQuotaOutput) ToServiceQuotaOutputWithContext added in v3.13.0 

func (o ServiceQuotaOutput) ToServiceQuotaOutputWithContext(ctx context.Context) ServiceQuotaOutput

func (ServiceQuotaOutput) ToServiceQuotaPtrOutput added in v3.25.0 

func (o ServiceQuotaOutput) ToServiceQuotaPtrOutput() ServiceQuotaPtrOutput

func (ServiceQuotaOutput) ToServiceQuotaPtrOutputWithContext added in v3.25.0 

func (o ServiceQuotaOutput) ToServiceQuotaPtrOutputWithContext(ctx context.Context) ServiceQuotaPtrOutput

type ServiceQuotaPtrInput added in v3.25.0 

type ServiceQuotaPtrInput interface {
	pulumi.Input

	ToServiceQuotaPtrOutput() ServiceQuotaPtrOutput
	ToServiceQuotaPtrOutputWithContext(ctx context.Context) ServiceQuotaPtrOutput
}

type ServiceQuotaPtrOutput added in v3.25.0 

type ServiceQuotaPtrOutput struct {
	*pulumi.OutputState
}

func (ServiceQuotaPtrOutput) ElementType added in v3.25.0 

func (ServiceQuotaPtrOutput) ElementType() reflect.Type

func (ServiceQuotaPtrOutput) ToServiceQuotaPtrOutput added in v3.25.0 

func (o ServiceQuotaPtrOutput) ToServiceQuotaPtrOutput() ServiceQuotaPtrOutput

func (ServiceQuotaPtrOutput) ToServiceQuotaPtrOutputWithContext added in v3.25.0 

func (o ServiceQuotaPtrOutput) ToServiceQuotaPtrOutputWithContext(ctx context.Context) ServiceQuotaPtrOutput

type ServiceQuotaState 

type ServiceQuotaState struct {
	// Whether the service quota can be increased.
	Adjustable pulumi.BoolPtrInput
	// Amazon Resource Name (ARN) of the service quota.
	Arn pulumi.StringPtrInput
	// Default value of the service quota.
	DefaultValue pulumi.Float64PtrInput
	// Code of the service quota to track. For example: `L-F678F1CE`. Available values can be found with the [AWS CLI service-quotas list-service-quotas command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html).
	QuotaCode pulumi.StringPtrInput
	// Name of the quota.
	QuotaName     pulumi.StringPtrInput
	RequestId     pulumi.StringPtrInput
	RequestStatus pulumi.StringPtrInput
	// Code of the service to track. For example: `vpc`. Available values can be found with the [AWS CLI service-quotas list-services command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-services.html).
	ServiceCode pulumi.StringPtrInput
	// Name of the service.
	ServiceName pulumi.StringPtrInput
	// Float specifying the desired value for the service quota. If the desired value is higher than the current value, a quota increase request is submitted. When a known request is submitted and pending, the value reflects the desired value of the pending request.
	Value pulumi.Float64PtrInput
}

func (ServiceQuotaState) ElementType 

func (ServiceQuotaState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.