Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. servicequotas
  5. Template
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.servicequotas.Template

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS Service Quotas Template.

    Only the management account of an organization can alter Service Quota templates, and this must be done from the us-east-1 region.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.servicequotas.Template("example", {
    region: "us-east-1",
    quotaCode: "L-2ACBD22F",
    serviceCode: "lambda",
    value: 80,
});

    import pulumi
import pulumi_aws as aws

example = aws.servicequotas.Template("example",
    region="us-east-1",
    quota_code="L-2ACBD22F",
    service_code="lambda",
    value=80)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/servicequotas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := servicequotas.NewTemplate(ctx, "example", &servicequotas.TemplateArgs{
			Region:      pulumi.String("us-east-1"),
			QuotaCode:   pulumi.String("L-2ACBD22F"),
			ServiceCode: pulumi.String("lambda"),
			Value:       pulumi.Float64(80),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.ServiceQuotas.Template("example", new()
    {
        Region = "us-east-1",
        QuotaCode = "L-2ACBD22F",
        ServiceCode = "lambda",
        Value = 80,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.servicequotas.Template;
import com.pulumi.aws.servicequotas.TemplateArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Template("example", TemplateArgs.builder()
            .region("us-east-1")
            .quotaCode("L-2ACBD22F")
            .serviceCode("lambda")
            .value("80")
            .build());

    }
}

    resources:
  example:
    type: aws:servicequotas:Template
    properties:
      region: us-east-1
      quotaCode: L-2ACBD22F
      serviceCode: lambda
      value: '80'

    Create Template Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Template(name: string, args: TemplateArgs, opts?: CustomResourceOptions);
    @overload
def Template(resource_name: str,
             args: TemplateArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Template(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             quota_code: Optional[str] = None,
             region: Optional[str] = None,
             service_code: Optional[str] = None,
             value: Optional[float] = None)
    func NewTemplate(ctx *Context, name string, args TemplateArgs, opts ...ResourceOption) (*Template, error)
    public Template(string name, TemplateArgs args, CustomResourceOptions? opts = null)
    public Template(String name, TemplateArgs args)
public Template(String name, TemplateArgs args, CustomResourceOptions options)

    type: aws:servicequotas:Template
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args TemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TemplateArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TemplateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var awsTemplateResource = new Aws.ServiceQuotas.Template("awsTemplateResource", new()
{
    QuotaCode = "string",
    Region = "string",
    ServiceCode = "string",
    Value = 0,
});

    example, err := servicequotas.NewTemplate(ctx, "awsTemplateResource", &servicequotas.TemplateArgs{
	QuotaCode:   pulumi.String("string"),
	Region:      pulumi.String("string"),
	ServiceCode: pulumi.String("string"),
	Value:       pulumi.Float64(0),
})

    var awsTemplateResource = new Template("awsTemplateResource", TemplateArgs.builder()
    .quotaCode("string")
    .region("string")
    .serviceCode("string")
    .value(0)
    .build());

    aws_template_resource = aws.servicequotas.Template("awsTemplateResource",
    quota_code="string",
    region="string",
    service_code="string",
    value=0)

    const awsTemplateResource = new aws.servicequotas.Template("awsTemplateResource", {
    quotaCode: "string",
    region: "string",
    serviceCode: "string",
    value: 0,
});

    type: aws:servicequotas:Template
properties:
    quotaCode: string
    region: string
    serviceCode: string
    value: 0

    Template Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Template resource accepts the following input properties:

    QuotaCode string
    Quota identifier. To find the quota code for a specific quota, use the aws.servicequotas.ServiceQuota data source.
    Region string
    AWS Region to which the template applies.
    ServiceCode string
    Service identifier. To find the service code value for an AWS service, use the aws.servicequotas.getService data source.
    Value double
    The new, increased value for the quota.
    QuotaCode string
    Quota identifier. To find the quota code for a specific quota, use the aws.servicequotas.ServiceQuota data source.
    Region string
    AWS Region to which the template applies.
    ServiceCode string
    Service identifier. To find the service code value for an AWS service, use the aws.servicequotas.getService data source.
    Value float64
    The new, increased value for the quota.
    quotaCode String
    Quota identifier. To find the quota code for a specific quota, use the aws.servicequotas.ServiceQuota data source.
    region String
    AWS Region to which the template applies.
    serviceCode String
    Service identifier. To find the service code value for an AWS service, use the aws.servicequotas.getService data source.
    value Double
    The new, increased value for the quota.
    quotaCode string
    Quota identifier. To find the quota code for a specific quota, use the aws.servicequotas.ServiceQuota data source.
    region string
    AWS Region to which the template applies.
    serviceCode string
    Service identifier. To find the service code value for an AWS service, use the aws.servicequotas.getService data source.
    value number
    The new, increased value for the quota.
    quota_code str
    Quota identifier. To find the quota code for a specific quota, use the aws.servicequotas.ServiceQuota data source.
    region str
    AWS Region to which the template applies.
    service_code str
    Service identifier. To find the service code value for an AWS service, use the aws.servicequotas.getService data source.
    value float
    The new, increased value for the quota.
    quotaCode String
    Quota identifier. To find the quota code for a specific quota, use the aws.servicequotas.ServiceQuota data source.
    region String
    AWS Region to which the template applies.
    serviceCode String
    Service identifier. To find the service code value for an AWS service, use the aws.servicequotas.getService data source.
    value Number
    The new, increased value for the quota.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Template resource produces the following output properties:

    GlobalQuota bool
    Indicates whether the quota is global.
    Id string
    The provider-assigned unique ID for this managed resource.
    QuotaName string
    Quota name.
    ServiceName string
    Service name.
    Unit string
    Unit of measurement.
    GlobalQuota bool
    Indicates whether the quota is global.
    Id string
    The provider-assigned unique ID for this managed resource.
    QuotaName string
    Quota name.
    ServiceName string
    Service name.
    Unit string
    Unit of measurement.
    globalQuota Boolean
    Indicates whether the quota is global.
    id String
    The provider-assigned unique ID for this managed resource.
    quotaName String
    Quota name.
    serviceName String
    Service name.
    unit String
    Unit of measurement.
    globalQuota boolean
    Indicates whether the quota is global.
    id string
    The provider-assigned unique ID for this managed resource.
    quotaName string
    Quota name.
    serviceName string
    Service name.
    unit string
    Unit of measurement.
    global_quota bool
    Indicates whether the quota is global.
    id str
    The provider-assigned unique ID for this managed resource.
    quota_name str
    Quota name.
    service_name str
    Service name.
    unit str
    Unit of measurement.
    globalQuota Boolean
    Indicates whether the quota is global.
    id String
    The provider-assigned unique ID for this managed resource.
    quotaName String
    Quota name.
    serviceName String
    Service name.
    unit String
    Unit of measurement.

    Look up Existing Template Resource

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

    public static get(name: string, id: Input<ID>, state?: TemplateState, opts?: CustomResourceOptions): Template
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        global_quota: Optional[bool] = None,
        quota_code: Optional[str] = None,
        quota_name: Optional[str] = None,
        region: Optional[str] = None,
        service_code: Optional[str] = None,
        service_name: Optional[str] = None,
        unit: Optional[str] = None,
        value: Optional[float] = None) -> Template
    func GetTemplate(ctx *Context, name string, id IDInput, state *TemplateState, opts ...ResourceOption) (*Template, error)
    public static Template Get(string name, Input<string> id, TemplateState? state, CustomResourceOptions? opts = null)
    public static Template get(String name, Output<String> id, TemplateState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    GlobalQuota bool
    Indicates whether the quota is global.
    QuotaCode string
    Quota identifier. To find the quota code for a specific quota, use the aws.servicequotas.ServiceQuota data source.
    QuotaName string
    Quota name.
    Region string
    AWS Region to which the template applies.
    ServiceCode string
    Service identifier. To find the service code value for an AWS service, use the aws.servicequotas.getService data source.
    ServiceName string
    Service name.
    Unit string
    Unit of measurement.
    Value double
    The new, increased value for the quota.
    GlobalQuota bool
    Indicates whether the quota is global.
    QuotaCode string
    Quota identifier. To find the quota code for a specific quota, use the aws.servicequotas.ServiceQuota data source.
    QuotaName string
    Quota name.
    Region string
    AWS Region to which the template applies.
    ServiceCode string
    Service identifier. To find the service code value for an AWS service, use the aws.servicequotas.getService data source.
    ServiceName string
    Service name.
    Unit string
    Unit of measurement.
    Value float64
    The new, increased value for the quota.
    globalQuota Boolean
    Indicates whether the quota is global.
    quotaCode String
    Quota identifier. To find the quota code for a specific quota, use the aws.servicequotas.ServiceQuota data source.
    quotaName String
    Quota name.
    region String
    AWS Region to which the template applies.
    serviceCode String
    Service identifier. To find the service code value for an AWS service, use the aws.servicequotas.getService data source.
    serviceName String
    Service name.
    unit String
    Unit of measurement.
    value Double
    The new, increased value for the quota.
    globalQuota boolean
    Indicates whether the quota is global.
    quotaCode string
    Quota identifier. To find the quota code for a specific quota, use the aws.servicequotas.ServiceQuota data source.
    quotaName string
    Quota name.
    region string
    AWS Region to which the template applies.
    serviceCode string
    Service identifier. To find the service code value for an AWS service, use the aws.servicequotas.getService data source.
    serviceName string
    Service name.
    unit string
    Unit of measurement.
    value number
    The new, increased value for the quota.
    global_quota bool
    Indicates whether the quota is global.
    quota_code str
    Quota identifier. To find the quota code for a specific quota, use the aws.servicequotas.ServiceQuota data source.
    quota_name str
    Quota name.
    region str
    AWS Region to which the template applies.
    service_code str
    Service identifier. To find the service code value for an AWS service, use the aws.servicequotas.getService data source.
    service_name str
    Service name.
    unit str
    Unit of measurement.
    value float
    The new, increased value for the quota.
    globalQuota Boolean
    Indicates whether the quota is global.
    quotaCode String
    Quota identifier. To find the quota code for a specific quota, use the aws.servicequotas.ServiceQuota data source.
    quotaName String
    Quota name.
    region String
    AWS Region to which the template applies.
    serviceCode String
    Service identifier. To find the service code value for an AWS service, use the aws.servicequotas.getService data source.
    serviceName String
    Service name.
    unit String
    Unit of measurement.
    value Number
    The new, increased value for the quota.

    Import

    Using pulumi import, import Service Quotas Template using the id. For example:

    $ pulumi import aws:servicequotas/template:Template example us-east-1,L-2ACBD22F,lambda

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws