1. Packages
  2. Exoscale
  3. API Docs
  4. IamApiKey
Exoscale v0.62.7 published on Tuesday, Dec 10, 2024 by Pulumiverse

exoscale.IamApiKey

Explore with Pulumi AI

exoscale logo
Exoscale v0.62.7 published on Tuesday, Dec 10, 2024 by Pulumiverse

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.exoscale.IamRole;
    import com.pulumi.exoscale.IamRoleArgs;
    import com.pulumi.exoscale.inputs.IamRolePolicyArgs;
    import com.pulumi.exoscale.IamApiKey;
    import com.pulumi.exoscale.IamApiKeyArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var myRole = new IamRole("myRole", IamRoleArgs.builder()
                .description("Example role")
                .editable(true)
                .policy(IamRolePolicyArgs.builder()
                    .default_service_strategy("deny")
                    .services(Map.of("sos", Map.of("type", "allow")))
                    .build())
                .build());
    
            var myApiKey = new IamApiKey("myApiKey", IamApiKeyArgs.builder()
                .roleId(myRole.id())
                .build());
    
        }
    }
    
    resources:
      myRole:
        type: exoscale:IamRole
        properties:
          description: Example role
          editable: true
          policy:
            default_service_strategy: deny
            services:
              sos:
                type: allow
      myApiKey:
        type: exoscale:IamApiKey
        properties:
          roleId: ${myRole.id}
    

    Please refer to the examples directory for complete configuration examples.

    Create IamApiKey Resource

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

    Constructor syntax

    new IamApiKey(name: string, args: IamApiKeyArgs, opts?: CustomResourceOptions);
    @overload
    def IamApiKey(resource_name: str,
                  args: IamApiKeyArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def IamApiKey(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  role_id: Optional[str] = None,
                  name: Optional[str] = None,
                  timeouts: Optional[IamApiKeyTimeoutsArgs] = None)
    func NewIamApiKey(ctx *Context, name string, args IamApiKeyArgs, opts ...ResourceOption) (*IamApiKey, error)
    public IamApiKey(string name, IamApiKeyArgs args, CustomResourceOptions? opts = null)
    public IamApiKey(String name, IamApiKeyArgs args)
    public IamApiKey(String name, IamApiKeyArgs args, CustomResourceOptions options)
    
    type: exoscale:IamApiKey
    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 IamApiKeyArgs
    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 IamApiKeyArgs
    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 IamApiKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IamApiKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IamApiKeyArgs
    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 iamApiKeyResource = new Exoscale.IamApiKey("iamApiKeyResource", new()
    {
        RoleId = "string",
        Name = "string",
        Timeouts = new Exoscale.Inputs.IamApiKeyTimeoutsArgs
        {
            Read = "string",
        },
    });
    
    example, err := exoscale.NewIamApiKey(ctx, "iamApiKeyResource", &exoscale.IamApiKeyArgs{
    	RoleId: pulumi.String("string"),
    	Name:   pulumi.String("string"),
    	Timeouts: &exoscale.IamApiKeyTimeoutsArgs{
    		Read: pulumi.String("string"),
    	},
    })
    
    var iamApiKeyResource = new IamApiKey("iamApiKeyResource", IamApiKeyArgs.builder()
        .roleId("string")
        .name("string")
        .timeouts(IamApiKeyTimeoutsArgs.builder()
            .read("string")
            .build())
        .build());
    
    iam_api_key_resource = exoscale.IamApiKey("iamApiKeyResource",
        role_id="string",
        name="string",
        timeouts={
            "read": "string",
        })
    
    const iamApiKeyResource = new exoscale.IamApiKey("iamApiKeyResource", {
        roleId: "string",
        name: "string",
        timeouts: {
            read: "string",
        },
    });
    
    type: exoscale:IamApiKey
    properties:
        name: string
        roleId: string
        timeouts:
            read: string
    

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

    RoleId string
    ❗ IAM API role ID.
    Name string
    ❗ IAM API Key name.
    Timeouts Pulumiverse.Exoscale.Inputs.IamApiKeyTimeouts
    RoleId string
    ❗ IAM API role ID.
    Name string
    ❗ IAM API Key name.
    Timeouts IamApiKeyTimeoutsArgs
    roleId String
    ❗ IAM API role ID.
    name String
    ❗ IAM API Key name.
    timeouts IamApiKeyTimeouts
    roleId string
    ❗ IAM API role ID.
    name string
    ❗ IAM API Key name.
    timeouts IamApiKeyTimeouts
    role_id str
    ❗ IAM API role ID.
    name str
    ❗ IAM API Key name.
    timeouts IamApiKeyTimeoutsArgs
    roleId String
    ❗ IAM API role ID.
    name String
    ❗ IAM API Key name.
    timeouts Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Key string
    The IAM API Key to match.
    Secret string
    Secret for the IAM API Key.
    Id string
    The provider-assigned unique ID for this managed resource.
    Key string
    The IAM API Key to match.
    Secret string
    Secret for the IAM API Key.
    id String
    The provider-assigned unique ID for this managed resource.
    key String
    The IAM API Key to match.
    secret String
    Secret for the IAM API Key.
    id string
    The provider-assigned unique ID for this managed resource.
    key string
    The IAM API Key to match.
    secret string
    Secret for the IAM API Key.
    id str
    The provider-assigned unique ID for this managed resource.
    key str
    The IAM API Key to match.
    secret str
    Secret for the IAM API Key.
    id String
    The provider-assigned unique ID for this managed resource.
    key String
    The IAM API Key to match.
    secret String
    Secret for the IAM API Key.

    Look up Existing IamApiKey Resource

    Get an existing IamApiKey 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?: IamApiKeyState, opts?: CustomResourceOptions): IamApiKey
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            key: Optional[str] = None,
            name: Optional[str] = None,
            role_id: Optional[str] = None,
            secret: Optional[str] = None,
            timeouts: Optional[IamApiKeyTimeoutsArgs] = None) -> IamApiKey
    func GetIamApiKey(ctx *Context, name string, id IDInput, state *IamApiKeyState, opts ...ResourceOption) (*IamApiKey, error)
    public static IamApiKey Get(string name, Input<string> id, IamApiKeyState? state, CustomResourceOptions? opts = null)
    public static IamApiKey get(String name, Output<String> id, IamApiKeyState 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:
    Key string
    The IAM API Key to match.
    Name string
    ❗ IAM API Key name.
    RoleId string
    ❗ IAM API role ID.
    Secret string
    Secret for the IAM API Key.
    Timeouts Pulumiverse.Exoscale.Inputs.IamApiKeyTimeouts
    Key string
    The IAM API Key to match.
    Name string
    ❗ IAM API Key name.
    RoleId string
    ❗ IAM API role ID.
    Secret string
    Secret for the IAM API Key.
    Timeouts IamApiKeyTimeoutsArgs
    key String
    The IAM API Key to match.
    name String
    ❗ IAM API Key name.
    roleId String
    ❗ IAM API role ID.
    secret String
    Secret for the IAM API Key.
    timeouts IamApiKeyTimeouts
    key string
    The IAM API Key to match.
    name string
    ❗ IAM API Key name.
    roleId string
    ❗ IAM API role ID.
    secret string
    Secret for the IAM API Key.
    timeouts IamApiKeyTimeouts
    key str
    The IAM API Key to match.
    name str
    ❗ IAM API Key name.
    role_id str
    ❗ IAM API role ID.
    secret str
    Secret for the IAM API Key.
    timeouts IamApiKeyTimeoutsArgs
    key String
    The IAM API Key to match.
    name String
    ❗ IAM API Key name.
    roleId String
    ❗ IAM API role ID.
    secret String
    Secret for the IAM API Key.
    timeouts Property Map

    Supporting Types

    IamApiKeyTimeouts, IamApiKeyTimeoutsArgs

    Read 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). Read operations occur during any refresh or planning operation when refresh is enabled.
    Read 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). Read operations occur during any refresh or planning operation when refresh is enabled.
    read 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). Read operations occur during any refresh or planning operation when refresh is enabled.
    read 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). Read operations occur during any refresh or planning operation when refresh is enabled.
    read 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). Read operations occur during any refresh or planning operation when refresh is enabled.
    read 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). Read operations occur during any refresh or planning operation when refresh is enabled.

    Package Details

    Repository
    exoscale pulumiverse/pulumi-exoscale
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the exoscale Terraform Provider.
    exoscale logo
    Exoscale v0.62.7 published on Tuesday, Dec 10, 2024 by Pulumiverse