akamai.GtmResource
Explore with Pulumi AI
Create GtmResource Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GtmResource(name: string, args: GtmResourceArgs, opts?: CustomResourceOptions);@overload
def GtmResource(resource_name: str,
                args: GtmResourceArgs,
                opts: Optional[ResourceOptions] = None)
@overload
def GtmResource(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                domain: Optional[str] = None,
                type: Optional[str] = None,
                aggregation_type: Optional[str] = None,
                leader_string: Optional[str] = None,
                description: Optional[str] = None,
                host_header: Optional[str] = None,
                decay_rate: Optional[float] = None,
                least_squares_decay: Optional[float] = None,
                load_imbalance_percentage: Optional[float] = None,
                max_u_multiplicative_increment: Optional[float] = None,
                name: Optional[str] = None,
                resource_instances: Optional[Sequence[GtmResourceResourceInstanceArgs]] = None,
                constrained_property: Optional[str] = None,
                upper_bound: Optional[int] = None,
                wait_on_complete: Optional[bool] = None)func NewGtmResource(ctx *Context, name string, args GtmResourceArgs, opts ...ResourceOption) (*GtmResource, error)public GtmResource(string name, GtmResourceArgs args, CustomResourceOptions? opts = null)
public GtmResource(String name, GtmResourceArgs args)
public GtmResource(String name, GtmResourceArgs args, CustomResourceOptions options)
type: akamai:GtmResource
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 GtmResourceArgs
- 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 GtmResourceArgs
- 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 GtmResourceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GtmResourceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GtmResourceArgs
- 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 gtmResourceResource = new Akamai.GtmResource("gtmResourceResource", new()
{
    Domain = "string",
    Type = "string",
    AggregationType = "string",
    LeaderString = "string",
    Description = "string",
    HostHeader = "string",
    DecayRate = 0,
    LeastSquaresDecay = 0,
    LoadImbalancePercentage = 0,
    MaxUMultiplicativeIncrement = 0,
    Name = "string",
    ResourceInstances = new[]
    {
        new Akamai.Inputs.GtmResourceResourceInstanceArgs
        {
            DatacenterId = 0,
            LoadObject = "string",
            LoadObjectPort = 0,
            LoadServers = new[]
            {
                "string",
            },
            UseDefaultLoadObject = false,
        },
    },
    ConstrainedProperty = "string",
    UpperBound = 0,
    WaitOnComplete = false,
});
example, err := akamai.NewGtmResource(ctx, "gtmResourceResource", &akamai.GtmResourceArgs{
	Domain:                      pulumi.String("string"),
	Type:                        pulumi.String("string"),
	AggregationType:             pulumi.String("string"),
	LeaderString:                pulumi.String("string"),
	Description:                 pulumi.String("string"),
	HostHeader:                  pulumi.String("string"),
	DecayRate:                   pulumi.Float64(0),
	LeastSquaresDecay:           pulumi.Float64(0),
	LoadImbalancePercentage:     pulumi.Float64(0),
	MaxUMultiplicativeIncrement: pulumi.Float64(0),
	Name:                        pulumi.String("string"),
	ResourceInstances: akamai.GtmResourceResourceInstanceArray{
		&akamai.GtmResourceResourceInstanceArgs{
			DatacenterId:   pulumi.Int(0),
			LoadObject:     pulumi.String("string"),
			LoadObjectPort: pulumi.Int(0),
			LoadServers: pulumi.StringArray{
				pulumi.String("string"),
			},
			UseDefaultLoadObject: pulumi.Bool(false),
		},
	},
	ConstrainedProperty: pulumi.String("string"),
	UpperBound:          pulumi.Int(0),
	WaitOnComplete:      pulumi.Bool(false),
})
var gtmResourceResource = new GtmResource("gtmResourceResource", GtmResourceArgs.builder()
    .domain("string")
    .type("string")
    .aggregationType("string")
    .leaderString("string")
    .description("string")
    .hostHeader("string")
    .decayRate(0)
    .leastSquaresDecay(0)
    .loadImbalancePercentage(0)
    .maxUMultiplicativeIncrement(0)
    .name("string")
    .resourceInstances(GtmResourceResourceInstanceArgs.builder()
        .datacenterId(0)
        .loadObject("string")
        .loadObjectPort(0)
        .loadServers("string")
        .useDefaultLoadObject(false)
        .build())
    .constrainedProperty("string")
    .upperBound(0)
    .waitOnComplete(false)
    .build());
gtm_resource_resource = akamai.GtmResource("gtmResourceResource",
    domain="string",
    type="string",
    aggregation_type="string",
    leader_string="string",
    description="string",
    host_header="string",
    decay_rate=0,
    least_squares_decay=0,
    load_imbalance_percentage=0,
    max_u_multiplicative_increment=0,
    name="string",
    resource_instances=[{
        "datacenter_id": 0,
        "load_object": "string",
        "load_object_port": 0,
        "load_servers": ["string"],
        "use_default_load_object": False,
    }],
    constrained_property="string",
    upper_bound=0,
    wait_on_complete=False)
const gtmResourceResource = new akamai.GtmResource("gtmResourceResource", {
    domain: "string",
    type: "string",
    aggregationType: "string",
    leaderString: "string",
    description: "string",
    hostHeader: "string",
    decayRate: 0,
    leastSquaresDecay: 0,
    loadImbalancePercentage: 0,
    maxUMultiplicativeIncrement: 0,
    name: "string",
    resourceInstances: [{
        datacenterId: 0,
        loadObject: "string",
        loadObjectPort: 0,
        loadServers: ["string"],
        useDefaultLoadObject: false,
    }],
    constrainedProperty: "string",
    upperBound: 0,
    waitOnComplete: false,
});
type: akamai:GtmResource
properties:
    aggregationType: string
    constrainedProperty: string
    decayRate: 0
    description: string
    domain: string
    hostHeader: string
    leaderString: string
    leastSquaresDecay: 0
    loadImbalancePercentage: 0
    maxUMultiplicativeIncrement: 0
    name: string
    resourceInstances:
        - datacenterId: 0
          loadObject: string
          loadObjectPort: 0
          loadServers:
            - string
          useDefaultLoadObject: false
    type: string
    upperBound: 0
    waitOnComplete: false
GtmResource 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 GtmResource resource accepts the following input properties:
- AggregationType string
- Domain string
- Type string
- ConstrainedProperty string
- DecayRate double
- Description string
- HostHeader string
- LeaderString string
- LeastSquares doubleDecay 
- LoadImbalance doublePercentage 
- MaxUMultiplicative doubleIncrement 
- Name string
- ResourceInstances List<GtmResource Resource Instance> 
- UpperBound int
- WaitOn boolComplete 
- AggregationType string
- Domain string
- Type string
- ConstrainedProperty string
- DecayRate float64
- Description string
- HostHeader string
- LeaderString string
- LeastSquares float64Decay 
- LoadImbalance float64Percentage 
- MaxUMultiplicative float64Increment 
- Name string
- ResourceInstances []GtmResource Resource Instance Args 
- UpperBound int
- WaitOn boolComplete 
- aggregationType String
- domain String
- type String
- constrainedProperty String
- decayRate Double
- description String
- hostHeader String
- leaderString String
- leastSquares DoubleDecay 
- loadImbalance DoublePercentage 
- maxUMultiplicative DoubleIncrement 
- name String
- resourceInstances List<GtmResource Resource Instance> 
- upperBound Integer
- waitOn BooleanComplete 
- aggregationType string
- domain string
- type string
- constrainedProperty string
- decayRate number
- description string
- hostHeader string
- leaderString string
- leastSquares numberDecay 
- loadImbalance numberPercentage 
- maxUMultiplicative numberIncrement 
- name string
- resourceInstances GtmResource Resource Instance[] 
- upperBound number
- waitOn booleanComplete 
- aggregation_type str
- domain str
- type str
- constrained_property str
- decay_rate float
- description str
- host_header str
- leader_string str
- least_squares_ floatdecay 
- load_imbalance_ floatpercentage 
- max_u_ floatmultiplicative_ increment 
- name str
- resource_instances Sequence[GtmResource Resource Instance Args] 
- upper_bound int
- wait_on_ boolcomplete 
- aggregationType String
- domain String
- type String
- constrainedProperty String
- decayRate Number
- description String
- hostHeader String
- leaderString String
- leastSquares NumberDecay 
- loadImbalance NumberPercentage 
- maxUMultiplicative NumberIncrement 
- name String
- resourceInstances List<Property Map>
- upperBound Number
- waitOn BooleanComplete 
Outputs
All input properties are implicitly available as output properties. Additionally, the GtmResource resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing GtmResource Resource
Get an existing GtmResource 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?: GtmResourceState, opts?: CustomResourceOptions): GtmResource@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aggregation_type: Optional[str] = None,
        constrained_property: Optional[str] = None,
        decay_rate: Optional[float] = None,
        description: Optional[str] = None,
        domain: Optional[str] = None,
        host_header: Optional[str] = None,
        leader_string: Optional[str] = None,
        least_squares_decay: Optional[float] = None,
        load_imbalance_percentage: Optional[float] = None,
        max_u_multiplicative_increment: Optional[float] = None,
        name: Optional[str] = None,
        resource_instances: Optional[Sequence[GtmResourceResourceInstanceArgs]] = None,
        type: Optional[str] = None,
        upper_bound: Optional[int] = None,
        wait_on_complete: Optional[bool] = None) -> GtmResourcefunc GetGtmResource(ctx *Context, name string, id IDInput, state *GtmResourceState, opts ...ResourceOption) (*GtmResource, error)public static GtmResource Get(string name, Input<string> id, GtmResourceState? state, CustomResourceOptions? opts = null)public static GtmResource get(String name, Output<String> id, GtmResourceState state, CustomResourceOptions options)resources:  _:    type: akamai:GtmResource    get:      id: ${id}- 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.
- AggregationType string
- ConstrainedProperty string
- DecayRate double
- Description string
- Domain string
- HostHeader string
- LeaderString string
- LeastSquares doubleDecay 
- LoadImbalance doublePercentage 
- MaxUMultiplicative doubleIncrement 
- Name string
- ResourceInstances List<GtmResource Resource Instance> 
- Type string
- UpperBound int
- WaitOn boolComplete 
- AggregationType string
- ConstrainedProperty string
- DecayRate float64
- Description string
- Domain string
- HostHeader string
- LeaderString string
- LeastSquares float64Decay 
- LoadImbalance float64Percentage 
- MaxUMultiplicative float64Increment 
- Name string
- ResourceInstances []GtmResource Resource Instance Args 
- Type string
- UpperBound int
- WaitOn boolComplete 
- aggregationType String
- constrainedProperty String
- decayRate Double
- description String
- domain String
- hostHeader String
- leaderString String
- leastSquares DoubleDecay 
- loadImbalance DoublePercentage 
- maxUMultiplicative DoubleIncrement 
- name String
- resourceInstances List<GtmResource Resource Instance> 
- type String
- upperBound Integer
- waitOn BooleanComplete 
- aggregationType string
- constrainedProperty string
- decayRate number
- description string
- domain string
- hostHeader string
- leaderString string
- leastSquares numberDecay 
- loadImbalance numberPercentage 
- maxUMultiplicative numberIncrement 
- name string
- resourceInstances GtmResource Resource Instance[] 
- type string
- upperBound number
- waitOn booleanComplete 
- aggregation_type str
- constrained_property str
- decay_rate float
- description str
- domain str
- host_header str
- leader_string str
- least_squares_ floatdecay 
- load_imbalance_ floatpercentage 
- max_u_ floatmultiplicative_ increment 
- name str
- resource_instances Sequence[GtmResource Resource Instance Args] 
- type str
- upper_bound int
- wait_on_ boolcomplete 
- aggregationType String
- constrainedProperty String
- decayRate Number
- description String
- domain String
- hostHeader String
- leaderString String
- leastSquares NumberDecay 
- loadImbalance NumberPercentage 
- maxUMultiplicative NumberIncrement 
- name String
- resourceInstances List<Property Map>
- type String
- upperBound Number
- waitOn BooleanComplete 
Supporting Types
GtmResourceResourceInstance, GtmResourceResourceInstanceArgs        
- DatacenterId int
- LoadObject string
- LoadObject intPort 
- LoadServers List<string>
- UseDefault boolLoad Object 
- DatacenterId int
- LoadObject string
- LoadObject intPort 
- LoadServers []string
- UseDefault boolLoad Object 
- datacenterId Integer
- loadObject String
- loadObject IntegerPort 
- loadServers List<String>
- useDefault BooleanLoad Object 
- datacenterId number
- loadObject string
- loadObject numberPort 
- loadServers string[]
- useDefault booleanLoad Object 
- datacenter_id int
- load_object str
- load_object_ intport 
- load_servers Sequence[str]
- use_default_ boolload_ object 
- datacenterId Number
- loadObject String
- loadObject NumberPort 
- loadServers List<String>
- useDefault BooleanLoad Object 
Package Details
- Repository
- Akamai pulumi/pulumi-akamai
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the akamaiTerraform Provider.