1. Packages
  2. Akamai
  3. API Docs
  4. CloudletsPolicy
Akamai v7.2.0 published on Friday, May 31, 2024 by Pulumi

akamai.CloudletsPolicy

Explore with Pulumi AI

akamai logo
Akamai v7.2.0 published on Friday, May 31, 2024 by Pulumi

    Create CloudletsPolicy Resource

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

    Constructor syntax

    new CloudletsPolicy(name: string, args: CloudletsPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def CloudletsPolicy(resource_name: str,
                        args: CloudletsPolicyArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def CloudletsPolicy(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        cloudlet_code: Optional[str] = None,
                        group_id: Optional[str] = None,
                        description: Optional[str] = None,
                        is_shared: Optional[bool] = None,
                        match_rule_format: Optional[str] = None,
                        match_rules: Optional[str] = None,
                        name: Optional[str] = None,
                        timeouts: Optional[CloudletsPolicyTimeoutsArgs] = None)
    func NewCloudletsPolicy(ctx *Context, name string, args CloudletsPolicyArgs, opts ...ResourceOption) (*CloudletsPolicy, error)
    public CloudletsPolicy(string name, CloudletsPolicyArgs args, CustomResourceOptions? opts = null)
    public CloudletsPolicy(String name, CloudletsPolicyArgs args)
    public CloudletsPolicy(String name, CloudletsPolicyArgs args, CustomResourceOptions options)
    
    type: akamai:CloudletsPolicy
    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 CloudletsPolicyArgs
    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 CloudletsPolicyArgs
    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 CloudletsPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudletsPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudletsPolicyArgs
    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 cloudletsPolicyResource = new Akamai.CloudletsPolicy("cloudletsPolicyResource", new()
    {
        CloudletCode = "string",
        GroupId = "string",
        Description = "string",
        IsShared = false,
        MatchRuleFormat = "string",
        MatchRules = "string",
        Name = "string",
        Timeouts = new Akamai.Inputs.CloudletsPolicyTimeoutsArgs
        {
            Default = "string",
        },
    });
    
    example, err := akamai.NewCloudletsPolicy(ctx, "cloudletsPolicyResource", &akamai.CloudletsPolicyArgs{
    	CloudletCode:    pulumi.String("string"),
    	GroupId:         pulumi.String("string"),
    	Description:     pulumi.String("string"),
    	IsShared:        pulumi.Bool(false),
    	MatchRuleFormat: pulumi.String("string"),
    	MatchRules:      pulumi.String("string"),
    	Name:            pulumi.String("string"),
    	Timeouts: &akamai.CloudletsPolicyTimeoutsArgs{
    		Default: pulumi.String("string"),
    	},
    })
    
    var cloudletsPolicyResource = new CloudletsPolicy("cloudletsPolicyResource", CloudletsPolicyArgs.builder()
        .cloudletCode("string")
        .groupId("string")
        .description("string")
        .isShared(false)
        .matchRuleFormat("string")
        .matchRules("string")
        .name("string")
        .timeouts(CloudletsPolicyTimeoutsArgs.builder()
            .default_("string")
            .build())
        .build());
    
    cloudlets_policy_resource = akamai.CloudletsPolicy("cloudletsPolicyResource",
        cloudlet_code="string",
        group_id="string",
        description="string",
        is_shared=False,
        match_rule_format="string",
        match_rules="string",
        name="string",
        timeouts=akamai.CloudletsPolicyTimeoutsArgs(
            default="string",
        ))
    
    const cloudletsPolicyResource = new akamai.CloudletsPolicy("cloudletsPolicyResource", {
        cloudletCode: "string",
        groupId: "string",
        description: "string",
        isShared: false,
        matchRuleFormat: "string",
        matchRules: "string",
        name: "string",
        timeouts: {
            "default": "string",
        },
    });
    
    type: akamai:CloudletsPolicy
    properties:
        cloudletCode: string
        description: string
        groupId: string
        isShared: false
        matchRuleFormat: string
        matchRules: string
        name: string
        timeouts:
            default: string
    

    CloudletsPolicy Resource Properties

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

    Inputs

    The CloudletsPolicy resource accepts the following input properties:

    CloudletCode string
    Code for the type of Cloudlet (ALB, AP, AS, CD, ER, FR, IG, or VP)
    GroupId string
    Defines the group association for the policy. You must have edit privileges for the group
    Description string
    The description of this specific policy
    IsShared bool
    The type of policy that you want to create
    MatchRuleFormat string
    The version of the Cloudlet specific matchRules
    MatchRules string
    A JSON structure that defines the rules for this policy
    Name string
    The name of the policy. The name must be unique
    Timeouts CloudletsPolicyTimeouts
    Enables to set timeout for processing
    CloudletCode string
    Code for the type of Cloudlet (ALB, AP, AS, CD, ER, FR, IG, or VP)
    GroupId string
    Defines the group association for the policy. You must have edit privileges for the group
    Description string
    The description of this specific policy
    IsShared bool
    The type of policy that you want to create
    MatchRuleFormat string
    The version of the Cloudlet specific matchRules
    MatchRules string
    A JSON structure that defines the rules for this policy
    Name string
    The name of the policy. The name must be unique
    Timeouts CloudletsPolicyTimeoutsArgs
    Enables to set timeout for processing
    cloudletCode String
    Code for the type of Cloudlet (ALB, AP, AS, CD, ER, FR, IG, or VP)
    groupId String
    Defines the group association for the policy. You must have edit privileges for the group
    description String
    The description of this specific policy
    isShared Boolean
    The type of policy that you want to create
    matchRuleFormat String
    The version of the Cloudlet specific matchRules
    matchRules String
    A JSON structure that defines the rules for this policy
    name String
    The name of the policy. The name must be unique
    timeouts CloudletsPolicyTimeouts
    Enables to set timeout for processing
    cloudletCode string
    Code for the type of Cloudlet (ALB, AP, AS, CD, ER, FR, IG, or VP)
    groupId string
    Defines the group association for the policy. You must have edit privileges for the group
    description string
    The description of this specific policy
    isShared boolean
    The type of policy that you want to create
    matchRuleFormat string
    The version of the Cloudlet specific matchRules
    matchRules string
    A JSON structure that defines the rules for this policy
    name string
    The name of the policy. The name must be unique
    timeouts CloudletsPolicyTimeouts
    Enables to set timeout for processing
    cloudlet_code str
    Code for the type of Cloudlet (ALB, AP, AS, CD, ER, FR, IG, or VP)
    group_id str
    Defines the group association for the policy. You must have edit privileges for the group
    description str
    The description of this specific policy
    is_shared bool
    The type of policy that you want to create
    match_rule_format str
    The version of the Cloudlet specific matchRules
    match_rules str
    A JSON structure that defines the rules for this policy
    name str
    The name of the policy. The name must be unique
    timeouts CloudletsPolicyTimeoutsArgs
    Enables to set timeout for processing
    cloudletCode String
    Code for the type of Cloudlet (ALB, AP, AS, CD, ER, FR, IG, or VP)
    groupId String
    Defines the group association for the policy. You must have edit privileges for the group
    description String
    The description of this specific policy
    isShared Boolean
    The type of policy that you want to create
    matchRuleFormat String
    The version of the Cloudlet specific matchRules
    matchRules String
    A JSON structure that defines the rules for this policy
    name String
    The name of the policy. The name must be unique
    timeouts Property Map
    Enables to set timeout for processing

    Outputs

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

    CloudletId int
    An integer that corresponds to a non-shared Cloudlets policy type (0 to 9). Not used for shared policies
    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The version number of the policy
    Warnings string
    A JSON encoded list of warnings
    CloudletId int
    An integer that corresponds to a non-shared Cloudlets policy type (0 to 9). Not used for shared policies
    Id string
    The provider-assigned unique ID for this managed resource.
    Version int
    The version number of the policy
    Warnings string
    A JSON encoded list of warnings
    cloudletId Integer
    An integer that corresponds to a non-shared Cloudlets policy type (0 to 9). Not used for shared policies
    id String
    The provider-assigned unique ID for this managed resource.
    version Integer
    The version number of the policy
    warnings String
    A JSON encoded list of warnings
    cloudletId number
    An integer that corresponds to a non-shared Cloudlets policy type (0 to 9). Not used for shared policies
    id string
    The provider-assigned unique ID for this managed resource.
    version number
    The version number of the policy
    warnings string
    A JSON encoded list of warnings
    cloudlet_id int
    An integer that corresponds to a non-shared Cloudlets policy type (0 to 9). Not used for shared policies
    id str
    The provider-assigned unique ID for this managed resource.
    version int
    The version number of the policy
    warnings str
    A JSON encoded list of warnings
    cloudletId Number
    An integer that corresponds to a non-shared Cloudlets policy type (0 to 9). Not used for shared policies
    id String
    The provider-assigned unique ID for this managed resource.
    version Number
    The version number of the policy
    warnings String
    A JSON encoded list of warnings

    Look up Existing CloudletsPolicy Resource

    Get an existing CloudletsPolicy 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?: CloudletsPolicyState, opts?: CustomResourceOptions): CloudletsPolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cloudlet_code: Optional[str] = None,
            cloudlet_id: Optional[int] = None,
            description: Optional[str] = None,
            group_id: Optional[str] = None,
            is_shared: Optional[bool] = None,
            match_rule_format: Optional[str] = None,
            match_rules: Optional[str] = None,
            name: Optional[str] = None,
            timeouts: Optional[CloudletsPolicyTimeoutsArgs] = None,
            version: Optional[int] = None,
            warnings: Optional[str] = None) -> CloudletsPolicy
    func GetCloudletsPolicy(ctx *Context, name string, id IDInput, state *CloudletsPolicyState, opts ...ResourceOption) (*CloudletsPolicy, error)
    public static CloudletsPolicy Get(string name, Input<string> id, CloudletsPolicyState? state, CustomResourceOptions? opts = null)
    public static CloudletsPolicy get(String name, Output<String> id, CloudletsPolicyState 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:
    CloudletCode string
    Code for the type of Cloudlet (ALB, AP, AS, CD, ER, FR, IG, or VP)
    CloudletId int
    An integer that corresponds to a non-shared Cloudlets policy type (0 to 9). Not used for shared policies
    Description string
    The description of this specific policy
    GroupId string
    Defines the group association for the policy. You must have edit privileges for the group
    IsShared bool
    The type of policy that you want to create
    MatchRuleFormat string
    The version of the Cloudlet specific matchRules
    MatchRules string
    A JSON structure that defines the rules for this policy
    Name string
    The name of the policy. The name must be unique
    Timeouts CloudletsPolicyTimeouts
    Enables to set timeout for processing
    Version int
    The version number of the policy
    Warnings string
    A JSON encoded list of warnings
    CloudletCode string
    Code for the type of Cloudlet (ALB, AP, AS, CD, ER, FR, IG, or VP)
    CloudletId int
    An integer that corresponds to a non-shared Cloudlets policy type (0 to 9). Not used for shared policies
    Description string
    The description of this specific policy
    GroupId string
    Defines the group association for the policy. You must have edit privileges for the group
    IsShared bool
    The type of policy that you want to create
    MatchRuleFormat string
    The version of the Cloudlet specific matchRules
    MatchRules string
    A JSON structure that defines the rules for this policy
    Name string
    The name of the policy. The name must be unique
    Timeouts CloudletsPolicyTimeoutsArgs
    Enables to set timeout for processing
    Version int
    The version number of the policy
    Warnings string
    A JSON encoded list of warnings
    cloudletCode String
    Code for the type of Cloudlet (ALB, AP, AS, CD, ER, FR, IG, or VP)
    cloudletId Integer
    An integer that corresponds to a non-shared Cloudlets policy type (0 to 9). Not used for shared policies
    description String
    The description of this specific policy
    groupId String
    Defines the group association for the policy. You must have edit privileges for the group
    isShared Boolean
    The type of policy that you want to create
    matchRuleFormat String
    The version of the Cloudlet specific matchRules
    matchRules String
    A JSON structure that defines the rules for this policy
    name String
    The name of the policy. The name must be unique
    timeouts CloudletsPolicyTimeouts
    Enables to set timeout for processing
    version Integer
    The version number of the policy
    warnings String
    A JSON encoded list of warnings
    cloudletCode string
    Code for the type of Cloudlet (ALB, AP, AS, CD, ER, FR, IG, or VP)
    cloudletId number
    An integer that corresponds to a non-shared Cloudlets policy type (0 to 9). Not used for shared policies
    description string
    The description of this specific policy
    groupId string
    Defines the group association for the policy. You must have edit privileges for the group
    isShared boolean
    The type of policy that you want to create
    matchRuleFormat string
    The version of the Cloudlet specific matchRules
    matchRules string
    A JSON structure that defines the rules for this policy
    name string
    The name of the policy. The name must be unique
    timeouts CloudletsPolicyTimeouts
    Enables to set timeout for processing
    version number
    The version number of the policy
    warnings string
    A JSON encoded list of warnings
    cloudlet_code str
    Code for the type of Cloudlet (ALB, AP, AS, CD, ER, FR, IG, or VP)
    cloudlet_id int
    An integer that corresponds to a non-shared Cloudlets policy type (0 to 9). Not used for shared policies
    description str
    The description of this specific policy
    group_id str
    Defines the group association for the policy. You must have edit privileges for the group
    is_shared bool
    The type of policy that you want to create
    match_rule_format str
    The version of the Cloudlet specific matchRules
    match_rules str
    A JSON structure that defines the rules for this policy
    name str
    The name of the policy. The name must be unique
    timeouts CloudletsPolicyTimeoutsArgs
    Enables to set timeout for processing
    version int
    The version number of the policy
    warnings str
    A JSON encoded list of warnings
    cloudletCode String
    Code for the type of Cloudlet (ALB, AP, AS, CD, ER, FR, IG, or VP)
    cloudletId Number
    An integer that corresponds to a non-shared Cloudlets policy type (0 to 9). Not used for shared policies
    description String
    The description of this specific policy
    groupId String
    Defines the group association for the policy. You must have edit privileges for the group
    isShared Boolean
    The type of policy that you want to create
    matchRuleFormat String
    The version of the Cloudlet specific matchRules
    matchRules String
    A JSON structure that defines the rules for this policy
    name String
    The name of the policy. The name must be unique
    timeouts Property Map
    Enables to set timeout for processing
    version Number
    The version number of the policy
    warnings String
    A JSON encoded list of warnings

    Supporting Types

    CloudletsPolicyTimeouts, CloudletsPolicyTimeoutsArgs

    Default string
    Default string
    default_ String
    default string
    default String

    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.2.0 published on Friday, May 31, 2024 by Pulumi