scaleway.IamApiKey
Explore with Pulumi AI
Creates and manages Scaleway API Keys. For more information, refer to the IAM API documentation.
Example Usage
With application
import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";
const ciCd = new scaleway.IamApplication("ci_cd", {name: "My application"});
const main = new scaleway.IamApiKey("main", {
applicationId: mainScalewayIamApplication.id,
description: "a description",
});
import pulumi
import pulumiverse_scaleway as scaleway
ci_cd = scaleway.IamApplication("ci_cd", name="My application")
main = scaleway.IamApiKey("main",
application_id=main_scaleway_iam_application["id"],
description="a description")
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := scaleway.NewIamApplication(ctx, "ci_cd", &scaleway.IamApplicationArgs{
Name: pulumi.String("My application"),
})
if err != nil {
return err
}
_, err = scaleway.NewIamApiKey(ctx, "main", &scaleway.IamApiKeyArgs{
ApplicationId: pulumi.Any(mainScalewayIamApplication.Id),
Description: pulumi.String("a description"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;
return await Deployment.RunAsync(() =>
{
var ciCd = new Scaleway.IamApplication("ci_cd", new()
{
Name = "My application",
});
var main = new Scaleway.IamApiKey("main", new()
{
ApplicationId = mainScalewayIamApplication.Id,
Description = "a description",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.IamApplication;
import com.pulumi.scaleway.IamApplicationArgs;
import com.pulumi.scaleway.IamApiKey;
import com.pulumi.scaleway.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 ciCd = new IamApplication("ciCd", IamApplicationArgs.builder()
.name("My application")
.build());
var main = new IamApiKey("main", IamApiKeyArgs.builder()
.applicationId(mainScalewayIamApplication.id())
.description("a description")
.build());
}
}
resources:
ciCd:
type: scaleway:IamApplication
name: ci_cd
properties:
name: My application
main:
type: scaleway:IamApiKey
properties:
applicationId: ${mainScalewayIamApplication.id}
description: a description
With user
import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";
const main = new scaleway.IamUser("main", {email: "test@test.com"});
const mainIamApiKey = new scaleway.IamApiKey("main", {
userId: main.id,
description: "a description",
});
import pulumi
import pulumiverse_scaleway as scaleway
main = scaleway.IamUser("main", email="test@test.com")
main_iam_api_key = scaleway.IamApiKey("main",
user_id=main.id,
description="a description")
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
main, err := scaleway.NewIamUser(ctx, "main", &scaleway.IamUserArgs{
Email: pulumi.String("test@test.com"),
})
if err != nil {
return err
}
_, err = scaleway.NewIamApiKey(ctx, "main", &scaleway.IamApiKeyArgs{
UserId: main.ID(),
Description: pulumi.String("a description"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;
return await Deployment.RunAsync(() =>
{
var main = new Scaleway.IamUser("main", new()
{
Email = "test@test.com",
});
var mainIamApiKey = new Scaleway.IamApiKey("main", new()
{
UserId = main.Id,
Description = "a description",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.IamUser;
import com.pulumi.scaleway.IamUserArgs;
import com.pulumi.scaleway.IamApiKey;
import com.pulumi.scaleway.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 main = new IamUser("main", IamUserArgs.builder()
.email("test@test.com")
.build());
var mainIamApiKey = new IamApiKey("mainIamApiKey", IamApiKeyArgs.builder()
.userId(main.id())
.description("a description")
.build());
}
}
resources:
main:
type: scaleway:IamUser
properties:
email: test@test.com
mainIamApiKey:
type: scaleway:IamApiKey
name: main
properties:
userId: ${main.id}
description: a description
With expiration
import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumiverse/scaleway";
import * as time from "@pulumi/time";
const rotateAfterAYear = new time.index.Rotating("rotate_after_a_year", {rotationYears: 1});
const main = new scaleway.IamApiKey("main", {
applicationId: mainScalewayIamApplication.id,
expiresAt: rotateAfterAYear.rotationRfc3339,
});
import pulumi
import pulumi_time as time
import pulumiverse_scaleway as scaleway
rotate_after_a_year = time.index.Rotating("rotate_after_a_year", rotation_years=1)
main = scaleway.IamApiKey("main",
application_id=main_scaleway_iam_application["id"],
expires_at=rotate_after_a_year["rotationRfc3339"])
package main
import (
"github.com/pulumi/pulumi-time/sdk/go/time"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
rotateAfterAYear, err := time.NewRotating(ctx, "rotate_after_a_year", &time.RotatingArgs{
RotationYears: 1,
})
if err != nil {
return err
}
_, err = scaleway.NewIamApiKey(ctx, "main", &scaleway.IamApiKeyArgs{
ApplicationId: pulumi.Any(mainScalewayIamApplication.Id),
ExpiresAt: rotateAfterAYear.RotationRfc3339,
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;
using Time = Pulumi.Time;
return await Deployment.RunAsync(() =>
{
var rotateAfterAYear = new Time.Index.Rotating("rotate_after_a_year", new()
{
RotationYears = 1,
});
var main = new Scaleway.IamApiKey("main", new()
{
ApplicationId = mainScalewayIamApplication.Id,
ExpiresAt = rotateAfterAYear.RotationRfc3339,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.time.rotating;
import com.pulumi.time.RotatingArgs;
import com.pulumi.scaleway.IamApiKey;
import com.pulumi.scaleway.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 rotateAfterAYear = new Rotating("rotateAfterAYear", RotatingArgs.builder()
.rotationYears(1)
.build());
var main = new IamApiKey("main", IamApiKeyArgs.builder()
.applicationId(mainScalewayIamApplication.id())
.expiresAt(rotateAfterAYear.rotationRfc3339())
.build());
}
}
resources:
rotateAfterAYear:
type: time:rotating
name: rotate_after_a_year
properties:
rotationYears: 1
main:
type: scaleway:IamApiKey
properties:
applicationId: ${mainScalewayIamApplication.id}
expiresAt: ${rotateAfterAYear.rotationRfc3339}
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: Optional[IamApiKeyArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def IamApiKey(resource_name: str,
opts: Optional[ResourceOptions] = None,
application_id: Optional[str] = None,
default_project_id: Optional[str] = None,
description: Optional[str] = None,
expires_at: Optional[str] = None,
user_id: Optional[str] = None)
func NewIamApiKey(ctx *Context, name string, args *IamApiKeyArgs, opts ...ResourceOption) (*IamApiKey, error)
public IamApiKey(string name, IamApiKeyArgs? args = null, CustomResourceOptions? opts = null)
public IamApiKey(String name, IamApiKeyArgs args)
public IamApiKey(String name, IamApiKeyArgs args, CustomResourceOptions options)
type: scaleway: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 Scaleway.IamApiKey("iamApiKeyResource", new()
{
ApplicationId = "string",
DefaultProjectId = "string",
Description = "string",
ExpiresAt = "string",
UserId = "string",
});
example, err := scaleway.NewIamApiKey(ctx, "iamApiKeyResource", &scaleway.IamApiKeyArgs{
ApplicationId: pulumi.String("string"),
DefaultProjectId: pulumi.String("string"),
Description: pulumi.String("string"),
ExpiresAt: pulumi.String("string"),
UserId: pulumi.String("string"),
})
var iamApiKeyResource = new IamApiKey("iamApiKeyResource", IamApiKeyArgs.builder()
.applicationId("string")
.defaultProjectId("string")
.description("string")
.expiresAt("string")
.userId("string")
.build());
iam_api_key_resource = scaleway.IamApiKey("iamApiKeyResource",
application_id="string",
default_project_id="string",
description="string",
expires_at="string",
user_id="string")
const iamApiKeyResource = new scaleway.IamApiKey("iamApiKeyResource", {
applicationId: "string",
defaultProjectId: "string",
description: "string",
expiresAt: "string",
userId: "string",
});
type: scaleway:IamApiKey
properties:
applicationId: string
defaultProjectId: string
description: string
expiresAt: string
userId: 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:
- Application
Id string - ID of the application attached to the API key.
- Default
Project stringId - The default Project ID to use with Object Storage.
- Description string
- The description of the API key.
- Expires
At string - The date and time of the expiration of the IAM API key. Please note that in case of any changes, the resource will be recreated.
- User
Id string ID of the user attached to the API key.
Note You must specify at least one:
application_id
and/oruser_id
.
- Application
Id string - ID of the application attached to the API key.
- Default
Project stringId - The default Project ID to use with Object Storage.
- Description string
- The description of the API key.
- Expires
At string - The date and time of the expiration of the IAM API key. Please note that in case of any changes, the resource will be recreated.
- User
Id string ID of the user attached to the API key.
Note You must specify at least one:
application_id
and/oruser_id
.
- application
Id String - ID of the application attached to the API key.
- default
Project StringId - The default Project ID to use with Object Storage.
- description String
- The description of the API key.
- expires
At String - The date and time of the expiration of the IAM API key. Please note that in case of any changes, the resource will be recreated.
- user
Id String ID of the user attached to the API key.
Note You must specify at least one:
application_id
and/oruser_id
.
- application
Id string - ID of the application attached to the API key.
- default
Project stringId - The default Project ID to use with Object Storage.
- description string
- The description of the API key.
- expires
At string - The date and time of the expiration of the IAM API key. Please note that in case of any changes, the resource will be recreated.
- user
Id string ID of the user attached to the API key.
Note You must specify at least one:
application_id
and/oruser_id
.
- application_
id str - ID of the application attached to the API key.
- default_
project_ strid - The default Project ID to use with Object Storage.
- description str
- The description of the API key.
- expires_
at str - The date and time of the expiration of the IAM API key. Please note that in case of any changes, the resource will be recreated.
- user_
id str ID of the user attached to the API key.
Note You must specify at least one:
application_id
and/oruser_id
.
- application
Id String - ID of the application attached to the API key.
- default
Project StringId - The default Project ID to use with Object Storage.
- description String
- The description of the API key.
- expires
At String - The date and time of the expiration of the IAM API key. Please note that in case of any changes, the resource will be recreated.
- user
Id String ID of the user attached to the API key.
Note You must specify at least one:
application_id
and/oruser_id
.
Outputs
All input properties are implicitly available as output properties. Additionally, the IamApiKey resource produces the following output properties:
- Access
Key string - The access key of the IAM API key.
- Created
At string - The date and time of the creation of the IAM API key.
- Creation
Ip string - The IP Address of the device which created the API key.
- Editable bool
- Whether the IAM API key is editable.
- Id string
- The provider-assigned unique ID for this managed resource.
- Secret
Key string - The secret Key of the IAM API key.
- Updated
At string - The date and time of the last update of the IAM API key.
- Access
Key string - The access key of the IAM API key.
- Created
At string - The date and time of the creation of the IAM API key.
- Creation
Ip string - The IP Address of the device which created the API key.
- Editable bool
- Whether the IAM API key is editable.
- Id string
- The provider-assigned unique ID for this managed resource.
- Secret
Key string - The secret Key of the IAM API key.
- Updated
At string - The date and time of the last update of the IAM API key.
- access
Key String - The access key of the IAM API key.
- created
At String - The date and time of the creation of the IAM API key.
- creation
Ip String - The IP Address of the device which created the API key.
- editable Boolean
- Whether the IAM API key is editable.
- id String
- The provider-assigned unique ID for this managed resource.
- secret
Key String - The secret Key of the IAM API key.
- updated
At String - The date and time of the last update of the IAM API key.
- access
Key string - The access key of the IAM API key.
- created
At string - The date and time of the creation of the IAM API key.
- creation
Ip string - The IP Address of the device which created the API key.
- editable boolean
- Whether the IAM API key is editable.
- id string
- The provider-assigned unique ID for this managed resource.
- secret
Key string - The secret Key of the IAM API key.
- updated
At string - The date and time of the last update of the IAM API key.
- access_
key str - The access key of the IAM API key.
- created_
at str - The date and time of the creation of the IAM API key.
- creation_
ip str - The IP Address of the device which created the API key.
- editable bool
- Whether the IAM API key is editable.
- id str
- The provider-assigned unique ID for this managed resource.
- secret_
key str - The secret Key of the IAM API key.
- updated_
at str - The date and time of the last update of the IAM API key.
- access
Key String - The access key of the IAM API key.
- created
At String - The date and time of the creation of the IAM API key.
- creation
Ip String - The IP Address of the device which created the API key.
- editable Boolean
- Whether the IAM API key is editable.
- id String
- The provider-assigned unique ID for this managed resource.
- secret
Key String - The secret Key of the IAM API key.
- updated
At String - The date and time of the last update of 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,
access_key: Optional[str] = None,
application_id: Optional[str] = None,
created_at: Optional[str] = None,
creation_ip: Optional[str] = None,
default_project_id: Optional[str] = None,
description: Optional[str] = None,
editable: Optional[bool] = None,
expires_at: Optional[str] = None,
secret_key: Optional[str] = None,
updated_at: Optional[str] = None,
user_id: Optional[str] = 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.
- Access
Key string - The access key of the IAM API key.
- Application
Id string - ID of the application attached to the API key.
- Created
At string - The date and time of the creation of the IAM API key.
- Creation
Ip string - The IP Address of the device which created the API key.
- Default
Project stringId - The default Project ID to use with Object Storage.
- Description string
- The description of the API key.
- Editable bool
- Whether the IAM API key is editable.
- Expires
At string - The date and time of the expiration of the IAM API key. Please note that in case of any changes, the resource will be recreated.
- Secret
Key string - The secret Key of the IAM API key.
- Updated
At string - The date and time of the last update of the IAM API key.
- User
Id string ID of the user attached to the API key.
Note You must specify at least one:
application_id
and/oruser_id
.
- Access
Key string - The access key of the IAM API key.
- Application
Id string - ID of the application attached to the API key.
- Created
At string - The date and time of the creation of the IAM API key.
- Creation
Ip string - The IP Address of the device which created the API key.
- Default
Project stringId - The default Project ID to use with Object Storage.
- Description string
- The description of the API key.
- Editable bool
- Whether the IAM API key is editable.
- Expires
At string - The date and time of the expiration of the IAM API key. Please note that in case of any changes, the resource will be recreated.
- Secret
Key string - The secret Key of the IAM API key.
- Updated
At string - The date and time of the last update of the IAM API key.
- User
Id string ID of the user attached to the API key.
Note You must specify at least one:
application_id
and/oruser_id
.
- access
Key String - The access key of the IAM API key.
- application
Id String - ID of the application attached to the API key.
- created
At String - The date and time of the creation of the IAM API key.
- creation
Ip String - The IP Address of the device which created the API key.
- default
Project StringId - The default Project ID to use with Object Storage.
- description String
- The description of the API key.
- editable Boolean
- Whether the IAM API key is editable.
- expires
At String - The date and time of the expiration of the IAM API key. Please note that in case of any changes, the resource will be recreated.
- secret
Key String - The secret Key of the IAM API key.
- updated
At String - The date and time of the last update of the IAM API key.
- user
Id String ID of the user attached to the API key.
Note You must specify at least one:
application_id
and/oruser_id
.
- access
Key string - The access key of the IAM API key.
- application
Id string - ID of the application attached to the API key.
- created
At string - The date and time of the creation of the IAM API key.
- creation
Ip string - The IP Address of the device which created the API key.
- default
Project stringId - The default Project ID to use with Object Storage.
- description string
- The description of the API key.
- editable boolean
- Whether the IAM API key is editable.
- expires
At string - The date and time of the expiration of the IAM API key. Please note that in case of any changes, the resource will be recreated.
- secret
Key string - The secret Key of the IAM API key.
- updated
At string - The date and time of the last update of the IAM API key.
- user
Id string ID of the user attached to the API key.
Note You must specify at least one:
application_id
and/oruser_id
.
- access_
key str - The access key of the IAM API key.
- application_
id str - ID of the application attached to the API key.
- created_
at str - The date and time of the creation of the IAM API key.
- creation_
ip str - The IP Address of the device which created the API key.
- default_
project_ strid - The default Project ID to use with Object Storage.
- description str
- The description of the API key.
- editable bool
- Whether the IAM API key is editable.
- expires_
at str - The date and time of the expiration of the IAM API key. Please note that in case of any changes, the resource will be recreated.
- secret_
key str - The secret Key of the IAM API key.
- updated_
at str - The date and time of the last update of the IAM API key.
- user_
id str ID of the user attached to the API key.
Note You must specify at least one:
application_id
and/oruser_id
.
- access
Key String - The access key of the IAM API key.
- application
Id String - ID of the application attached to the API key.
- created
At String - The date and time of the creation of the IAM API key.
- creation
Ip String - The IP Address of the device which created the API key.
- default
Project StringId - The default Project ID to use with Object Storage.
- description String
- The description of the API key.
- editable Boolean
- Whether the IAM API key is editable.
- expires
At String - The date and time of the expiration of the IAM API key. Please note that in case of any changes, the resource will be recreated.
- secret
Key String - The secret Key of the IAM API key.
- updated
At String - The date and time of the last update of the IAM API key.
- user
Id String ID of the user attached to the API key.
Note You must specify at least one:
application_id
and/oruser_id
.
Import
Api keys can be imported using the {id}
, e.g.
bash
$ pulumi import scaleway:index/iamApiKey:IamApiKey main 11111111111111111111
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- scaleway pulumiverse/pulumi-scaleway
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scaleway
Terraform Provider.