Docs Packages
  1. Packages
  2. Akamai
  3. API Docs
  4. EdgeWorker
Akamai v7.2.0 published on Friday, May 31, 2024 by Pulumi
pulumi/pulumi-akamai

akamai.EdgeWorker

Explore with Pulumi AI

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

    Create EdgeWorker Resource

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

    Constructor syntax

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

@overload
def EdgeWorker(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               group_id: Optional[int] = None,
               resource_tier_id: Optional[int] = None,
               local_bundle: Optional[str] = None,
               name: Optional[str] = None,
               timeouts: Optional[EdgeWorkerTimeoutsArgs] = None)
    func NewEdgeWorker(ctx *Context, name string, args EdgeWorkerArgs, opts ...ResourceOption) (*EdgeWorker, error)
    public EdgeWorker(string name, EdgeWorkerArgs args, CustomResourceOptions? opts = null)
    public EdgeWorker(String name, EdgeWorkerArgs args)
public EdgeWorker(String name, EdgeWorkerArgs args, CustomResourceOptions options)

    type: akamai:EdgeWorker
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 EdgeWorkerArgs
    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 EdgeWorkerArgs
    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 EdgeWorkerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EdgeWorkerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EdgeWorkerArgs
    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 edgeWorkerResource = new Akamai.EdgeWorker("edgeWorkerResource", new()
{
    GroupId = 0,
    ResourceTierId = 0,
    LocalBundle = "string",
    Name = "string",
    Timeouts = new Akamai.Inputs.EdgeWorkerTimeoutsArgs
    {
        Default = "string",
    },
});

    example, err := akamai.NewEdgeWorker(ctx, "edgeWorkerResource", &akamai.EdgeWorkerArgs{
	GroupId:        pulumi.Int(0),
	ResourceTierId: pulumi.Int(0),
	LocalBundle:    pulumi.String("string"),
	Name:           pulumi.String("string"),
	Timeouts: &akamai.EdgeWorkerTimeoutsArgs{
		Default: pulumi.String("string"),
	},
})

    var edgeWorkerResource = new EdgeWorker("edgeWorkerResource", EdgeWorkerArgs.builder()
    .groupId(0)
    .resourceTierId(0)
    .localBundle("string")
    .name("string")
    .timeouts(EdgeWorkerTimeoutsArgs.builder()
        .default_("string")
        .build())
    .build());

    edge_worker_resource = akamai.EdgeWorker("edgeWorkerResource",
    group_id=0,
    resource_tier_id=0,
    local_bundle="string",
    name="string",
    timeouts=akamai.EdgeWorkerTimeoutsArgs(
        default="string",
    ))

    const edgeWorkerResource = new akamai.EdgeWorker("edgeWorkerResource", {
    groupId: 0,
    resourceTierId: 0,
    localBundle: "string",
    name: "string",
    timeouts: {
        "default": "string",
    },
});

    type: akamai:EdgeWorker
properties:
    groupId: 0
    localBundle: string
    name: string
    resourceTierId: 0
    timeouts:
        default: string

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

    GroupId int
    Defines the group association for the EdgeWorker
    ResourceTierId int
    The unique identifier of a resource tier
    LocalBundle string
    The path to the EdgeWorkers tgz code bundle
    Name string
    The EdgeWorker name
    Timeouts EdgeWorkerTimeouts
    Enables to set timeout for processing
    GroupId int
    Defines the group association for the EdgeWorker
    ResourceTierId int
    The unique identifier of a resource tier
    LocalBundle string
    The path to the EdgeWorkers tgz code bundle
    Name string
    The EdgeWorker name
    Timeouts EdgeWorkerTimeoutsArgs
    Enables to set timeout for processing
    groupId Integer
    Defines the group association for the EdgeWorker
    resourceTierId Integer
    The unique identifier of a resource tier
    localBundle String
    The path to the EdgeWorkers tgz code bundle
    name String
    The EdgeWorker name
    timeouts EdgeWorkerTimeouts
    Enables to set timeout for processing
    groupId number
    Defines the group association for the EdgeWorker
    resourceTierId number
    The unique identifier of a resource tier
    localBundle string
    The path to the EdgeWorkers tgz code bundle
    name string
    The EdgeWorker name
    timeouts EdgeWorkerTimeouts
    Enables to set timeout for processing
    group_id int
    Defines the group association for the EdgeWorker
    resource_tier_id int
    The unique identifier of a resource tier
    local_bundle str
    The path to the EdgeWorkers tgz code bundle
    name str
    The EdgeWorker name
    timeouts EdgeWorkerTimeoutsArgs
    Enables to set timeout for processing
    groupId Number
    Defines the group association for the EdgeWorker
    resourceTierId Number
    The unique identifier of a resource tier
    localBundle String
    The path to the EdgeWorkers tgz code bundle
    name String
    The EdgeWorker name
    timeouts Property Map
    Enables to set timeout for processing

    Outputs

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

    EdgeworkerId int
    The unique identifier of the EdgeWorker
    Id string
    The provider-assigned unique ID for this managed resource.
    LocalBundleHash string
    The local bundle hash for the EdgeWorker
    Version string
    The bundle version
    Warnings List<string>
    The list of warnings returned by EdgeWorker validation
    EdgeworkerId int
    The unique identifier of the EdgeWorker
    Id string
    The provider-assigned unique ID for this managed resource.
    LocalBundleHash string
    The local bundle hash for the EdgeWorker
    Version string
    The bundle version
    Warnings []string
    The list of warnings returned by EdgeWorker validation
    edgeworkerId Integer
    The unique identifier of the EdgeWorker
    id String
    The provider-assigned unique ID for this managed resource.
    localBundleHash String
    The local bundle hash for the EdgeWorker
    version String
    The bundle version
    warnings List<String>
    The list of warnings returned by EdgeWorker validation
    edgeworkerId number
    The unique identifier of the EdgeWorker
    id string
    The provider-assigned unique ID for this managed resource.
    localBundleHash string
    The local bundle hash for the EdgeWorker
    version string
    The bundle version
    warnings string[]
    The list of warnings returned by EdgeWorker validation
    edgeworker_id int
    The unique identifier of the EdgeWorker
    id str
    The provider-assigned unique ID for this managed resource.
    local_bundle_hash str
    The local bundle hash for the EdgeWorker
    version str
    The bundle version
    warnings Sequence[str]
    The list of warnings returned by EdgeWorker validation
    edgeworkerId Number
    The unique identifier of the EdgeWorker
    id String
    The provider-assigned unique ID for this managed resource.
    localBundleHash String
    The local bundle hash for the EdgeWorker
    version String
    The bundle version
    warnings List<String>
    The list of warnings returned by EdgeWorker validation

    Look up Existing EdgeWorker Resource

    Get an existing EdgeWorker 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?: EdgeWorkerState, opts?: CustomResourceOptions): EdgeWorker
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        edgeworker_id: Optional[int] = None,
        group_id: Optional[int] = None,
        local_bundle: Optional[str] = None,
        local_bundle_hash: Optional[str] = None,
        name: Optional[str] = None,
        resource_tier_id: Optional[int] = None,
        timeouts: Optional[EdgeWorkerTimeoutsArgs] = None,
        version: Optional[str] = None,
        warnings: Optional[Sequence[str]] = None) -> EdgeWorker
    func GetEdgeWorker(ctx *Context, name string, id IDInput, state *EdgeWorkerState, opts ...ResourceOption) (*EdgeWorker, error)
    public static EdgeWorker Get(string name, Input<string> id, EdgeWorkerState? state, CustomResourceOptions? opts = null)
    public static EdgeWorker get(String name, Output<String> id, EdgeWorkerState 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:
    EdgeworkerId int
    The unique identifier of the EdgeWorker
    GroupId int
    Defines the group association for the EdgeWorker
    LocalBundle string
    The path to the EdgeWorkers tgz code bundle
    LocalBundleHash string
    The local bundle hash for the EdgeWorker
    Name string
    The EdgeWorker name
    ResourceTierId int
    The unique identifier of a resource tier
    Timeouts EdgeWorkerTimeouts
    Enables to set timeout for processing
    Version string
    The bundle version
    Warnings List<string>
    The list of warnings returned by EdgeWorker validation
    EdgeworkerId int
    The unique identifier of the EdgeWorker
    GroupId int
    Defines the group association for the EdgeWorker
    LocalBundle string
    The path to the EdgeWorkers tgz code bundle
    LocalBundleHash string
    The local bundle hash for the EdgeWorker
    Name string
    The EdgeWorker name
    ResourceTierId int
    The unique identifier of a resource tier
    Timeouts EdgeWorkerTimeoutsArgs
    Enables to set timeout for processing
    Version string
    The bundle version
    Warnings []string
    The list of warnings returned by EdgeWorker validation
    edgeworkerId Integer
    The unique identifier of the EdgeWorker
    groupId Integer
    Defines the group association for the EdgeWorker
    localBundle String
    The path to the EdgeWorkers tgz code bundle
    localBundleHash String
    The local bundle hash for the EdgeWorker
    name String
    The EdgeWorker name
    resourceTierId Integer
    The unique identifier of a resource tier
    timeouts EdgeWorkerTimeouts
    Enables to set timeout for processing
    version String
    The bundle version
    warnings List<String>
    The list of warnings returned by EdgeWorker validation
    edgeworkerId number
    The unique identifier of the EdgeWorker
    groupId number
    Defines the group association for the EdgeWorker
    localBundle string
    The path to the EdgeWorkers tgz code bundle
    localBundleHash string
    The local bundle hash for the EdgeWorker
    name string
    The EdgeWorker name
    resourceTierId number
    The unique identifier of a resource tier
    timeouts EdgeWorkerTimeouts
    Enables to set timeout for processing
    version string
    The bundle version
    warnings string[]
    The list of warnings returned by EdgeWorker validation
    edgeworker_id int
    The unique identifier of the EdgeWorker
    group_id int
    Defines the group association for the EdgeWorker
    local_bundle str
    The path to the EdgeWorkers tgz code bundle
    local_bundle_hash str
    The local bundle hash for the EdgeWorker
    name str
    The EdgeWorker name
    resource_tier_id int
    The unique identifier of a resource tier
    timeouts EdgeWorkerTimeoutsArgs
    Enables to set timeout for processing
    version str
    The bundle version
    warnings Sequence[str]
    The list of warnings returned by EdgeWorker validation
    edgeworkerId Number
    The unique identifier of the EdgeWorker
    groupId Number
    Defines the group association for the EdgeWorker
    localBundle String
    The path to the EdgeWorkers tgz code bundle
    localBundleHash String
    The local bundle hash for the EdgeWorker
    name String
    The EdgeWorker name
    resourceTierId Number
    The unique identifier of a resource tier
    timeouts Property Map
    Enables to set timeout for processing
    version String
    The bundle version
    warnings List<String>
    The list of warnings returned by EdgeWorker validation

    Supporting Types

    EdgeWorkerTimeouts, EdgeWorkerTimeoutsArgs

    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
    pulumi/pulumi-akamai