Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Outscale Provider
  3. API Docs
  4. Policy
outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
outscale/terraform-provider-outscale

outscale.Policy

Explore with Pulumi AI

outscale logo
outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
outscale/terraform-provider-outscale

    Manages a policy.

    For more information on this resource, see the User Guide.
    For more information on this resource actions, see the API documentation.

    Example Usage

    resource "outscale_policy" "policy-1"  {
   policy_name = "terraform-policy-1"
   description = "test-terraform"
   document    = file("policy.json")
   path        = "/"
}

    Create Policy Resource

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

    Constructor syntax

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

@overload
def Policy(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           document: Optional[str] = None,
           policy_name: Optional[str] = None,
           description: Optional[str] = None,
           outscale_policy_id: Optional[str] = None,
           path: Optional[str] = None)
    func NewPolicy(ctx *Context, name string, args PolicyArgs, opts ...ResourceOption) (*Policy, error)
    public Policy(string name, PolicyArgs args, CustomResourceOptions? opts = null)
    public Policy(String name, PolicyArgs args)
public Policy(String name, PolicyArgs args, CustomResourceOptions options)

    type: outscale:Policy
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 PolicyArgs
    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 PolicyArgs
    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 PolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyArgs
    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 policyResource = new Outscale.Policy("policyResource", new()
{
    Document = "string",
    PolicyName = "string",
    Description = "string",
    OutscalePolicyId = "string",
    Path = "string",
});

    example, err := outscale.NewPolicy(ctx, "policyResource", &outscale.PolicyArgs{
Document: pulumi.String("string"),
PolicyName: pulumi.String("string"),
Description: pulumi.String("string"),
OutscalePolicyId: pulumi.String("string"),
Path: pulumi.String("string"),
})

    var policyResource = new Policy("policyResource", PolicyArgs.builder()
    .document("string")
    .policyName("string")
    .description("string")
    .outscalePolicyId("string")
    .path("string")
    .build());

    policy_resource = outscale.Policy("policyResource",
    document="string",
    policy_name="string",
    description="string",
    outscale_policy_id="string",
    path="string")

    const policyResource = new outscale.Policy("policyResource", {
    document: "string",
    policyName: "string",
    description: "string",
    outscalePolicyId: "string",
    path: "string",
});

    type: outscale:Policy
properties:
    description: string
    document: string
    outscalePolicyId: string
    path: string
    policyName: string

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

    Document string
    The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information and EIM Policy Generator.
    PolicyName string
    The name of the policy.
    Description string
    A description for the policy.
    OutscalePolicyId string
    Path string
    The path of the policy.
    Document string
    The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information and EIM Policy Generator.
    PolicyName string
    The name of the policy.
    Description string
    A description for the policy.
    OutscalePolicyId string
    Path string
    The path of the policy.
    document String
    The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information and EIM Policy Generator.
    policyName String
    The name of the policy.
    description String
    A description for the policy.
    outscalePolicyId String
    path String
    The path of the policy.
    document string
    The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information and EIM Policy Generator.
    policyName string
    The name of the policy.
    description string
    A description for the policy.
    outscalePolicyId string
    path string
    The path of the policy.
    document str
    The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information and EIM Policy Generator.
    policy_name str
    The name of the policy.
    description str
    A description for the policy.
    outscale_policy_id str
    path str
    The path of the policy.
    document String
    The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information and EIM Policy Generator.
    policyName String
    The name of the policy.
    description String
    A description for the policy.
    outscalePolicyId String
    path String
    The path of the policy.

    Outputs

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

    CreationDate string
    The date and time (UTC) at which the policy was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsLinkable bool
    Indicates whether the policy can be linked to a group or an EIM user.
    LastModificationDate string
    The date and time (UTC) at which the policy was last modified.
    Orn string
    The OUTSCALE Resource Name (ORN) of the policy. For more information, see Resource Identifiers.
    PolicyDefaultVersionId string
    The ID of the policy default version.
    PolicyId string
    The ID of the policy.
    ResourcesCount double
    The number of resources attached to the policy.
    CreationDate string
    The date and time (UTC) at which the policy was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsLinkable bool
    Indicates whether the policy can be linked to a group or an EIM user.
    LastModificationDate string
    The date and time (UTC) at which the policy was last modified.
    Orn string
    The OUTSCALE Resource Name (ORN) of the policy. For more information, see Resource Identifiers.
    PolicyDefaultVersionId string
    The ID of the policy default version.
    PolicyId string
    The ID of the policy.
    ResourcesCount float64
    The number of resources attached to the policy.
    creationDate String
    The date and time (UTC) at which the policy was created.
    id String
    The provider-assigned unique ID for this managed resource.
    isLinkable Boolean
    Indicates whether the policy can be linked to a group or an EIM user.
    lastModificationDate String
    The date and time (UTC) at which the policy was last modified.
    orn String
    The OUTSCALE Resource Name (ORN) of the policy. For more information, see Resource Identifiers.
    policyDefaultVersionId String
    The ID of the policy default version.
    policyId String
    The ID of the policy.
    resourcesCount Double
    The number of resources attached to the policy.
    creationDate string
    The date and time (UTC) at which the policy was created.
    id string
    The provider-assigned unique ID for this managed resource.
    isLinkable boolean
    Indicates whether the policy can be linked to a group or an EIM user.
    lastModificationDate string
    The date and time (UTC) at which the policy was last modified.
    orn string
    The OUTSCALE Resource Name (ORN) of the policy. For more information, see Resource Identifiers.
    policyDefaultVersionId string
    The ID of the policy default version.
    policyId string
    The ID of the policy.
    resourcesCount number
    The number of resources attached to the policy.
    creation_date str
    The date and time (UTC) at which the policy was created.
    id str
    The provider-assigned unique ID for this managed resource.
    is_linkable bool
    Indicates whether the policy can be linked to a group or an EIM user.
    last_modification_date str
    The date and time (UTC) at which the policy was last modified.
    orn str
    The OUTSCALE Resource Name (ORN) of the policy. For more information, see Resource Identifiers.
    policy_default_version_id str
    The ID of the policy default version.
    policy_id str
    The ID of the policy.
    resources_count float
    The number of resources attached to the policy.
    creationDate String
    The date and time (UTC) at which the policy was created.
    id String
    The provider-assigned unique ID for this managed resource.
    isLinkable Boolean
    Indicates whether the policy can be linked to a group or an EIM user.
    lastModificationDate String
    The date and time (UTC) at which the policy was last modified.
    orn String
    The OUTSCALE Resource Name (ORN) of the policy. For more information, see Resource Identifiers.
    policyDefaultVersionId String
    The ID of the policy default version.
    policyId String
    The ID of the policy.
    resourcesCount Number
    The number of resources attached to the policy.

    Look up Existing Policy Resource

    Get an existing Policy 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?: PolicyState, opts?: CustomResourceOptions): Policy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        creation_date: Optional[str] = None,
        description: Optional[str] = None,
        document: Optional[str] = None,
        is_linkable: Optional[bool] = None,
        last_modification_date: Optional[str] = None,
        orn: Optional[str] = None,
        outscale_policy_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_default_version_id: Optional[str] = None,
        policy_id: Optional[str] = None,
        policy_name: Optional[str] = None,
        resources_count: Optional[float] = None) -> Policy
    func GetPolicy(ctx *Context, name string, id IDInput, state *PolicyState, opts ...ResourceOption) (*Policy, error)
    public static Policy Get(string name, Input<string> id, PolicyState? state, CustomResourceOptions? opts = null)
    public static Policy get(String name, Output<String> id, PolicyState state, CustomResourceOptions options)
    resources:  _:    type: outscale:Policy    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.
    The following state arguments are supported:
    CreationDate string
    The date and time (UTC) at which the policy was created.
    Description string
    A description for the policy.
    Document string
    The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information and EIM Policy Generator.
    IsLinkable bool
    Indicates whether the policy can be linked to a group or an EIM user.
    LastModificationDate string
    The date and time (UTC) at which the policy was last modified.
    Orn string
    The OUTSCALE Resource Name (ORN) of the policy. For more information, see Resource Identifiers.
    OutscalePolicyId string
    Path string
    The path of the policy.
    PolicyDefaultVersionId string
    The ID of the policy default version.
    PolicyId string
    The ID of the policy.
    PolicyName string
    The name of the policy.
    ResourcesCount double
    The number of resources attached to the policy.
    CreationDate string
    The date and time (UTC) at which the policy was created.
    Description string
    A description for the policy.
    Document string
    The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information and EIM Policy Generator.
    IsLinkable bool
    Indicates whether the policy can be linked to a group or an EIM user.
    LastModificationDate string
    The date and time (UTC) at which the policy was last modified.
    Orn string
    The OUTSCALE Resource Name (ORN) of the policy. For more information, see Resource Identifiers.
    OutscalePolicyId string
    Path string
    The path of the policy.
    PolicyDefaultVersionId string
    The ID of the policy default version.
    PolicyId string
    The ID of the policy.
    PolicyName string
    The name of the policy.
    ResourcesCount float64
    The number of resources attached to the policy.
    creationDate String
    The date and time (UTC) at which the policy was created.
    description String
    A description for the policy.
    document String
    The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information and EIM Policy Generator.
    isLinkable Boolean
    Indicates whether the policy can be linked to a group or an EIM user.
    lastModificationDate String
    The date and time (UTC) at which the policy was last modified.
    orn String
    The OUTSCALE Resource Name (ORN) of the policy. For more information, see Resource Identifiers.
    outscalePolicyId String
    path String
    The path of the policy.
    policyDefaultVersionId String
    The ID of the policy default version.
    policyId String
    The ID of the policy.
    policyName String
    The name of the policy.
    resourcesCount Double
    The number of resources attached to the policy.
    creationDate string
    The date and time (UTC) at which the policy was created.
    description string
    A description for the policy.
    document string
    The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information and EIM Policy Generator.
    isLinkable boolean
    Indicates whether the policy can be linked to a group or an EIM user.
    lastModificationDate string
    The date and time (UTC) at which the policy was last modified.
    orn string
    The OUTSCALE Resource Name (ORN) of the policy. For more information, see Resource Identifiers.
    outscalePolicyId string
    path string
    The path of the policy.
    policyDefaultVersionId string
    The ID of the policy default version.
    policyId string
    The ID of the policy.
    policyName string
    The name of the policy.
    resourcesCount number
    The number of resources attached to the policy.
    creation_date str
    The date and time (UTC) at which the policy was created.
    description str
    A description for the policy.
    document str
    The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information and EIM Policy Generator.
    is_linkable bool
    Indicates whether the policy can be linked to a group or an EIM user.
    last_modification_date str
    The date and time (UTC) at which the policy was last modified.
    orn str
    The OUTSCALE Resource Name (ORN) of the policy. For more information, see Resource Identifiers.
    outscale_policy_id str
    path str
    The path of the policy.
    policy_default_version_id str
    The ID of the policy default version.
    policy_id str
    The ID of the policy.
    policy_name str
    The name of the policy.
    resources_count float
    The number of resources attached to the policy.
    creationDate String
    The date and time (UTC) at which the policy was created.
    description String
    A description for the policy.
    document String
    The policy document, corresponding to a JSON string that contains the policy. For more information, see EIM Reference Information and EIM Policy Generator.
    isLinkable Boolean
    Indicates whether the policy can be linked to a group or an EIM user.
    lastModificationDate String
    The date and time (UTC) at which the policy was last modified.
    orn String
    The OUTSCALE Resource Name (ORN) of the policy. For more information, see Resource Identifiers.
    outscalePolicyId String
    path String
    The path of the policy.
    policyDefaultVersionId String
    The ID of the policy default version.
    policyId String
    The ID of the policy.
    policyName String
    The name of the policy.
    resourcesCount Number
    The number of resources attached to the policy.

    Import

    A policy can be imported using its ORN. For example:

    console

    $ pulumi import outscale:index/policy:Policy policy1 orn

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

    Package Details

    Repository
    outscale outscale/terraform-provider-outscale
    License
    Notes
    This Pulumi package is based on the outscale Terraform Provider.
    outscale logo
    outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
    outscale/terraform-provider-outscale