Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Akamai
  3. API Docs
  4. CloudwrapperConfiguration
Akamai v7.5.0 published on Friday, Oct 11, 2024 by Pulumi
pulumi/pulumi-akamai

akamai.CloudwrapperConfiguration

Explore with Pulumi AI

akamai logo
Akamai v7.5.0 published on Friday, Oct 11, 2024 by Pulumi
pulumi/pulumi-akamai

    Create CloudwrapperConfiguration Resource

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

    Constructor syntax

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

@overload
def CloudwrapperConfiguration(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              comments: Optional[str] = None,
                              config_name: Optional[str] = None,
                              contract_id: Optional[str] = None,
                              property_ids: Optional[Sequence[str]] = None,
                              capacity_alerts_threshold: Optional[int] = None,
                              locations: Optional[Sequence[CloudwrapperConfigurationLocationArgs]] = None,
                              notification_emails: Optional[Sequence[str]] = None,
                              retain_idle_objects: Optional[bool] = None,
                              timeouts: Optional[CloudwrapperConfigurationTimeoutsArgs] = None)
    func NewCloudwrapperConfiguration(ctx *Context, name string, args CloudwrapperConfigurationArgs, opts ...ResourceOption) (*CloudwrapperConfiguration, error)
    public CloudwrapperConfiguration(string name, CloudwrapperConfigurationArgs args, CustomResourceOptions? opts = null)
    public CloudwrapperConfiguration(String name, CloudwrapperConfigurationArgs args)
public CloudwrapperConfiguration(String name, CloudwrapperConfigurationArgs args, CustomResourceOptions options)

    type: akamai:CloudwrapperConfiguration
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 CloudwrapperConfigurationArgs
    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 CloudwrapperConfigurationArgs
    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 CloudwrapperConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudwrapperConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudwrapperConfigurationArgs
    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 cloudwrapperConfigurationResource = new Akamai.CloudwrapperConfiguration("cloudwrapperConfigurationResource", new()
{
    Comments = "string",
    ConfigName = "string",
    ContractId = "string",
    PropertyIds = new[]
    {
        "string",
    },
    CapacityAlertsThreshold = 0,
    Locations = new[]
    {
        new Akamai.Inputs.CloudwrapperConfigurationLocationArgs
        {
            Comments = "string",
            TrafficTypeId = 0,
            Capacity = new Akamai.Inputs.CloudwrapperConfigurationLocationCapacityArgs
            {
                Unit = "string",
                Value = 0,
            },
        },
    },
    NotificationEmails = new[]
    {
        "string",
    },
    RetainIdleObjects = false,
    Timeouts = new Akamai.Inputs.CloudwrapperConfigurationTimeoutsArgs
    {
        Delete = "string",
    },
});

    example, err := akamai.NewCloudwrapperConfiguration(ctx, "cloudwrapperConfigurationResource", &akamai.CloudwrapperConfigurationArgs{
	Comments:   pulumi.String("string"),
	ConfigName: pulumi.String("string"),
	ContractId: pulumi.String("string"),
	PropertyIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	CapacityAlertsThreshold: pulumi.Int(0),
	Locations: akamai.CloudwrapperConfigurationLocationArray{
		&akamai.CloudwrapperConfigurationLocationArgs{
			Comments:      pulumi.String("string"),
			TrafficTypeId: pulumi.Int(0),
			Capacity: &akamai.CloudwrapperConfigurationLocationCapacityArgs{
				Unit:  pulumi.String("string"),
				Value: pulumi.Int(0),
			},
		},
	},
	NotificationEmails: pulumi.StringArray{
		pulumi.String("string"),
	},
	RetainIdleObjects: pulumi.Bool(false),
	Timeouts: &akamai.CloudwrapperConfigurationTimeoutsArgs{
		Delete: pulumi.String("string"),
	},
})

    var cloudwrapperConfigurationResource = new CloudwrapperConfiguration("cloudwrapperConfigurationResource", CloudwrapperConfigurationArgs.builder()
    .comments("string")
    .configName("string")
    .contractId("string")
    .propertyIds("string")
    .capacityAlertsThreshold(0)
    .locations(CloudwrapperConfigurationLocationArgs.builder()
        .comments("string")
        .trafficTypeId(0)
        .capacity(CloudwrapperConfigurationLocationCapacityArgs.builder()
            .unit("string")
            .value(0)
            .build())
        .build())
    .notificationEmails("string")
    .retainIdleObjects(false)
    .timeouts(CloudwrapperConfigurationTimeoutsArgs.builder()
        .delete("string")
        .build())
    .build());

    cloudwrapper_configuration_resource = akamai.CloudwrapperConfiguration("cloudwrapperConfigurationResource",
    comments="string",
    config_name="string",
    contract_id="string",
    property_ids=["string"],
    capacity_alerts_threshold=0,
    locations=[{
        "comments": "string",
        "traffic_type_id": 0,
        "capacity": {
            "unit": "string",
            "value": 0,
        },
    }],
    notification_emails=["string"],
    retain_idle_objects=False,
    timeouts={
        "delete": "string",
    })

    const cloudwrapperConfigurationResource = new akamai.CloudwrapperConfiguration("cloudwrapperConfigurationResource", {
    comments: "string",
    configName: "string",
    contractId: "string",
    propertyIds: ["string"],
    capacityAlertsThreshold: 0,
    locations: [{
        comments: "string",
        trafficTypeId: 0,
        capacity: {
            unit: "string",
            value: 0,
        },
    }],
    notificationEmails: ["string"],
    retainIdleObjects: false,
    timeouts: {
        "delete": "string",
    },
});

    type: akamai:CloudwrapperConfiguration
properties:
    capacityAlertsThreshold: 0
    comments: string
    configName: string
    contractId: string
    locations:
        - capacity:
            unit: string
            value: 0
          comments: string
          trafficTypeId: 0
    notificationEmails:
        - string
    propertyIds:
        - string
    retainIdleObjects: false
    timeouts:
        delete: string

    CloudwrapperConfiguration 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 CloudwrapperConfiguration resource accepts the following input properties:

    Comments string
    Additional information you provide to differentiate or track changes of the configuration.
    ConfigName string
    Name of the configuration.
    ContractId string
    Contract ID having Cloud Wrapper entitlement.
    PropertyIds List<string>
    List of properties belonging to eligible products.
    CapacityAlertsThreshold int
    Capacity Alerts enablement information for the configuration. The Alert Threshold should be between 50 and 100.
    Locations List<CloudwrapperConfigurationLocation>
    List of locations to use with the configuration.
    NotificationEmails List<string>
    Email addresses to use for notifications.
    RetainIdleObjects bool
    Retain idle objects beyond their max idle lifetime.
    Timeouts CloudwrapperConfigurationTimeouts
    Comments string
    Additional information you provide to differentiate or track changes of the configuration.
    ConfigName string
    Name of the configuration.
    ContractId string
    Contract ID having Cloud Wrapper entitlement.
    PropertyIds []string
    List of properties belonging to eligible products.
    CapacityAlertsThreshold int
    Capacity Alerts enablement information for the configuration. The Alert Threshold should be between 50 and 100.
    Locations []CloudwrapperConfigurationLocationArgs
    List of locations to use with the configuration.
    NotificationEmails []string
    Email addresses to use for notifications.
    RetainIdleObjects bool
    Retain idle objects beyond their max idle lifetime.
    Timeouts CloudwrapperConfigurationTimeoutsArgs
    comments String
    Additional information you provide to differentiate or track changes of the configuration.
    configName String
    Name of the configuration.
    contractId String
    Contract ID having Cloud Wrapper entitlement.
    propertyIds List<String>
    List of properties belonging to eligible products.
    capacityAlertsThreshold Integer
    Capacity Alerts enablement information for the configuration. The Alert Threshold should be between 50 and 100.
    locations List<CloudwrapperConfigurationLocation>
    List of locations to use with the configuration.
    notificationEmails List<String>
    Email addresses to use for notifications.
    retainIdleObjects Boolean
    Retain idle objects beyond their max idle lifetime.
    timeouts CloudwrapperConfigurationTimeouts
    comments string
    Additional information you provide to differentiate or track changes of the configuration.
    configName string
    Name of the configuration.
    contractId string
    Contract ID having Cloud Wrapper entitlement.
    propertyIds string[]
    List of properties belonging to eligible products.
    capacityAlertsThreshold number
    Capacity Alerts enablement information for the configuration. The Alert Threshold should be between 50 and 100.
    locations CloudwrapperConfigurationLocation[]
    List of locations to use with the configuration.
    notificationEmails string[]
    Email addresses to use for notifications.
    retainIdleObjects boolean
    Retain idle objects beyond their max idle lifetime.
    timeouts CloudwrapperConfigurationTimeouts
    comments str
    Additional information you provide to differentiate or track changes of the configuration.
    config_name str
    Name of the configuration.
    contract_id str
    Contract ID having Cloud Wrapper entitlement.
    property_ids Sequence[str]
    List of properties belonging to eligible products.
    capacity_alerts_threshold int
    Capacity Alerts enablement information for the configuration. The Alert Threshold should be between 50 and 100.
    locations Sequence[CloudwrapperConfigurationLocationArgs]
    List of locations to use with the configuration.
    notification_emails Sequence[str]
    Email addresses to use for notifications.
    retain_idle_objects bool
    Retain idle objects beyond their max idle lifetime.
    timeouts CloudwrapperConfigurationTimeoutsArgs
    comments String
    Additional information you provide to differentiate or track changes of the configuration.
    configName String
    Name of the configuration.
    contractId String
    Contract ID having Cloud Wrapper entitlement.
    propertyIds List<String>
    List of properties belonging to eligible products.
    capacityAlertsThreshold Number
    Capacity Alerts enablement information for the configuration. The Alert Threshold should be between 50 and 100.
    locations List<Property Map>
    List of locations to use with the configuration.
    notificationEmails List<String>
    Email addresses to use for notifications.
    retainIdleObjects Boolean
    Retain idle objects beyond their max idle lifetime.
    timeouts Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Revision string
    Unique hash value of the configuration.
    Id string
    The provider-assigned unique ID for this managed resource.
    Revision string
    Unique hash value of the configuration.
    id String
    The provider-assigned unique ID for this managed resource.
    revision String
    Unique hash value of the configuration.
    id string
    The provider-assigned unique ID for this managed resource.
    revision string
    Unique hash value of the configuration.
    id str
    The provider-assigned unique ID for this managed resource.
    revision str
    Unique hash value of the configuration.
    id String
    The provider-assigned unique ID for this managed resource.
    revision String
    Unique hash value of the configuration.

    Look up Existing CloudwrapperConfiguration Resource

    Get an existing CloudwrapperConfiguration 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?: CloudwrapperConfigurationState, opts?: CustomResourceOptions): CloudwrapperConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        capacity_alerts_threshold: Optional[int] = None,
        comments: Optional[str] = None,
        config_name: Optional[str] = None,
        contract_id: Optional[str] = None,
        locations: Optional[Sequence[CloudwrapperConfigurationLocationArgs]] = None,
        notification_emails: Optional[Sequence[str]] = None,
        property_ids: Optional[Sequence[str]] = None,
        retain_idle_objects: Optional[bool] = None,
        revision: Optional[str] = None,
        timeouts: Optional[CloudwrapperConfigurationTimeoutsArgs] = None) -> CloudwrapperConfiguration
    func GetCloudwrapperConfiguration(ctx *Context, name string, id IDInput, state *CloudwrapperConfigurationState, opts ...ResourceOption) (*CloudwrapperConfiguration, error)
    public static CloudwrapperConfiguration Get(string name, Input<string> id, CloudwrapperConfigurationState? state, CustomResourceOptions? opts = null)
    public static CloudwrapperConfiguration get(String name, Output<String> id, CloudwrapperConfigurationState 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:
    CapacityAlertsThreshold int
    Capacity Alerts enablement information for the configuration. The Alert Threshold should be between 50 and 100.
    Comments string
    Additional information you provide to differentiate or track changes of the configuration.
    ConfigName string
    Name of the configuration.
    ContractId string
    Contract ID having Cloud Wrapper entitlement.
    Locations List<CloudwrapperConfigurationLocation>
    List of locations to use with the configuration.
    NotificationEmails List<string>
    Email addresses to use for notifications.
    PropertyIds List<string>
    List of properties belonging to eligible products.
    RetainIdleObjects bool
    Retain idle objects beyond their max idle lifetime.
    Revision string
    Unique hash value of the configuration.
    Timeouts CloudwrapperConfigurationTimeouts
    CapacityAlertsThreshold int
    Capacity Alerts enablement information for the configuration. The Alert Threshold should be between 50 and 100.
    Comments string
    Additional information you provide to differentiate or track changes of the configuration.
    ConfigName string
    Name of the configuration.
    ContractId string
    Contract ID having Cloud Wrapper entitlement.
    Locations []CloudwrapperConfigurationLocationArgs
    List of locations to use with the configuration.
    NotificationEmails []string
    Email addresses to use for notifications.
    PropertyIds []string
    List of properties belonging to eligible products.
    RetainIdleObjects bool
    Retain idle objects beyond their max idle lifetime.
    Revision string
    Unique hash value of the configuration.
    Timeouts CloudwrapperConfigurationTimeoutsArgs
    capacityAlertsThreshold Integer
    Capacity Alerts enablement information for the configuration. The Alert Threshold should be between 50 and 100.
    comments String
    Additional information you provide to differentiate or track changes of the configuration.
    configName String
    Name of the configuration.
    contractId String
    Contract ID having Cloud Wrapper entitlement.
    locations List<CloudwrapperConfigurationLocation>
    List of locations to use with the configuration.
    notificationEmails List<String>
    Email addresses to use for notifications.
    propertyIds List<String>
    List of properties belonging to eligible products.
    retainIdleObjects Boolean
    Retain idle objects beyond their max idle lifetime.
    revision String
    Unique hash value of the configuration.
    timeouts CloudwrapperConfigurationTimeouts
    capacityAlertsThreshold number
    Capacity Alerts enablement information for the configuration. The Alert Threshold should be between 50 and 100.
    comments string
    Additional information you provide to differentiate or track changes of the configuration.
    configName string
    Name of the configuration.
    contractId string
    Contract ID having Cloud Wrapper entitlement.
    locations CloudwrapperConfigurationLocation[]
    List of locations to use with the configuration.
    notificationEmails string[]
    Email addresses to use for notifications.
    propertyIds string[]
    List of properties belonging to eligible products.
    retainIdleObjects boolean
    Retain idle objects beyond their max idle lifetime.
    revision string
    Unique hash value of the configuration.
    timeouts CloudwrapperConfigurationTimeouts
    capacity_alerts_threshold int
    Capacity Alerts enablement information for the configuration. The Alert Threshold should be between 50 and 100.
    comments str
    Additional information you provide to differentiate or track changes of the configuration.
    config_name str
    Name of the configuration.
    contract_id str
    Contract ID having Cloud Wrapper entitlement.
    locations Sequence[CloudwrapperConfigurationLocationArgs]
    List of locations to use with the configuration.
    notification_emails Sequence[str]
    Email addresses to use for notifications.
    property_ids Sequence[str]
    List of properties belonging to eligible products.
    retain_idle_objects bool
    Retain idle objects beyond their max idle lifetime.
    revision str
    Unique hash value of the configuration.
    timeouts CloudwrapperConfigurationTimeoutsArgs
    capacityAlertsThreshold Number
    Capacity Alerts enablement information for the configuration. The Alert Threshold should be between 50 and 100.
    comments String
    Additional information you provide to differentiate or track changes of the configuration.
    configName String
    Name of the configuration.
    contractId String
    Contract ID having Cloud Wrapper entitlement.
    locations List<Property Map>
    List of locations to use with the configuration.
    notificationEmails List<String>
    Email addresses to use for notifications.
    propertyIds List<String>
    List of properties belonging to eligible products.
    retainIdleObjects Boolean
    Retain idle objects beyond their max idle lifetime.
    revision String
    Unique hash value of the configuration.
    timeouts Property Map

    Supporting Types

    CloudwrapperConfigurationLocation, CloudwrapperConfigurationLocationArgs

    Comments string
    Additional comments provided by the user.
    TrafficTypeId int
    Unique identifier for the location and traffic type combination
    Capacity CloudwrapperConfigurationLocationCapacity
    The capacity assigned to this configuration's location
    Comments string
    Additional comments provided by the user.
    TrafficTypeId int
    Unique identifier for the location and traffic type combination
    Capacity CloudwrapperConfigurationLocationCapacity
    The capacity assigned to this configuration's location
    comments String
    Additional comments provided by the user.
    trafficTypeId Integer
    Unique identifier for the location and traffic type combination
    capacity CloudwrapperConfigurationLocationCapacity
    The capacity assigned to this configuration's location
    comments string
    Additional comments provided by the user.
    trafficTypeId number
    Unique identifier for the location and traffic type combination
    capacity CloudwrapperConfigurationLocationCapacity
    The capacity assigned to this configuration's location
    comments str
    Additional comments provided by the user.
    traffic_type_id int
    Unique identifier for the location and traffic type combination
    capacity CloudwrapperConfigurationLocationCapacity
    The capacity assigned to this configuration's location
    comments String
    Additional comments provided by the user.
    trafficTypeId Number
    Unique identifier for the location and traffic type combination
    capacity Property Map
    The capacity assigned to this configuration's location

    CloudwrapperConfigurationLocationCapacity, CloudwrapperConfigurationLocationCapacityArgs

    Unit string
    Unit of capacity. Can be either 'GB' or 'TB'.
    Value int
    Value of capacity.
    Unit string
    Unit of capacity. Can be either 'GB' or 'TB'.
    Value int
    Value of capacity.
    unit String
    Unit of capacity. Can be either 'GB' or 'TB'.
    value Integer
    Value of capacity.
    unit string
    Unit of capacity. Can be either 'GB' or 'TB'.
    value number
    Value of capacity.
    unit str
    Unit of capacity. Can be either 'GB' or 'TB'.
    value int
    Value of capacity.
    unit String
    Unit of capacity. Can be either 'GB' or 'TB'.
    value Number
    Value of capacity.

    CloudwrapperConfigurationTimeouts, CloudwrapperConfigurationTimeoutsArgs

    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

    Package Details

    Repository
    Akamai pulumi/pulumi-akamai
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the akamai Terraform Provider.
    akamai logo
    Akamai v7.5.0 published on Friday, Oct 11, 2024 by Pulumi
    pulumi/pulumi-akamai