Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Akamai
  3. API Docs
  4. IamRole
Akamai v8.1.0 published on Friday, Apr 11, 2025 by Pulumi
pulumi/pulumi-akamai

akamai.IamRole

Explore with Pulumi AI

Akamai v8.1.0 published on Friday, Apr 11, 2025 by Pulumi
pulumi/pulumi-akamai

Create IamRole Resource

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

Constructor syntax

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

@overload
def IamRole(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            granted_roles: Optional[Sequence[int]] = None,
            name: Optional[str] = None,
            type: Optional[str] = None)
func NewIamRole(ctx *Context, name string, args IamRoleArgs, opts ...ResourceOption) (*IamRole, error)
public IamRole(string name, IamRoleArgs args, CustomResourceOptions? opts = null)
public IamRole(String name, IamRoleArgs args)
public IamRole(String name, IamRoleArgs args, CustomResourceOptions options)

type: akamai:IamRole
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IamRoleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IamRoleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IamRoleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IamRoleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IamRoleArgs
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 iamRoleResource = new Akamai.IamRole("iamRoleResource", new()
{
    Description = "string",
    GrantedRoles = new[]
    {
        0,
    },
    Name = "string",
    Type = "string",
});
Copy
example, err := akamai.NewIamRole(ctx, "iamRoleResource", &akamai.IamRoleArgs{
	Description: pulumi.String("string"),
	GrantedRoles: pulumi.IntArray{
		pulumi.Int(0),
	},
	Name: pulumi.String("string"),
	Type: pulumi.String("string"),
})
Copy
var iamRoleResource = new IamRole("iamRoleResource", IamRoleArgs.builder()
    .description("string")
    .grantedRoles(0)
    .name("string")
    .type("string")
    .build());
Copy
iam_role_resource = akamai.IamRole("iamRoleResource",
    description="string",
    granted_roles=[0],
    name="string",
    type="string")
Copy
const iamRoleResource = new akamai.IamRole("iamRoleResource", {
    description: "string",
    grantedRoles: [0],
    name: "string",
    type: "string",
});
Copy
type: akamai:IamRole
properties:
    description: string
    grantedRoles:
        - 0
    name: string
    type: string
Copy

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

Description This property is required. string
The description for a role.
GrantedRoles This property is required. List<int>
The list of existing unique identifiers for the granted roles.
Name string
The name you supply for a role.
Type string
The role type which indicates whether it's a standard role provided by Akamai or a custom role for the account.
Description This property is required. string
The description for a role.
GrantedRoles This property is required. []int
The list of existing unique identifiers for the granted roles.
Name string
The name you supply for a role.
Type string
The role type which indicates whether it's a standard role provided by Akamai or a custom role for the account.
description This property is required. String
The description for a role.
grantedRoles This property is required. List<Integer>
The list of existing unique identifiers for the granted roles.
name String
The name you supply for a role.
type String
The role type which indicates whether it's a standard role provided by Akamai or a custom role for the account.
description This property is required. string
The description for a role.
grantedRoles This property is required. number[]
The list of existing unique identifiers for the granted roles.
name string
The name you supply for a role.
type string
The role type which indicates whether it's a standard role provided by Akamai or a custom role for the account.
description This property is required. str
The description for a role.
granted_roles This property is required. Sequence[int]
The list of existing unique identifiers for the granted roles.
name str
The name you supply for a role.
type str
The role type which indicates whether it's a standard role provided by Akamai or a custom role for the account.
description This property is required. String
The description for a role.
grantedRoles This property is required. List<Number>
The list of existing unique identifiers for the granted roles.
name String
The name you supply for a role.
type String
The role type which indicates whether it's a standard role provided by Akamai or a custom role for the account.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing IamRole Resource

Get an existing IamRole 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?: IamRoleState, opts?: CustomResourceOptions): IamRole
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        granted_roles: Optional[Sequence[int]] = None,
        name: Optional[str] = None,
        type: Optional[str] = None) -> IamRole
func GetIamRole(ctx *Context, name string, id IDInput, state *IamRoleState, opts ...ResourceOption) (*IamRole, error)
public static IamRole Get(string name, Input<string> id, IamRoleState? state, CustomResourceOptions? opts = null)
public static IamRole get(String name, Output<String> id, IamRoleState state, CustomResourceOptions options)
resources:  _:    type: akamai:IamRole    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
The description for a role.
GrantedRoles List<int>
The list of existing unique identifiers for the granted roles.
Name string
The name you supply for a role.
Type string
The role type which indicates whether it's a standard role provided by Akamai or a custom role for the account.
Description string
The description for a role.
GrantedRoles []int
The list of existing unique identifiers for the granted roles.
Name string
The name you supply for a role.
Type string
The role type which indicates whether it's a standard role provided by Akamai or a custom role for the account.
description String
The description for a role.
grantedRoles List<Integer>
The list of existing unique identifiers for the granted roles.
name String
The name you supply for a role.
type String
The role type which indicates whether it's a standard role provided by Akamai or a custom role for the account.
description string
The description for a role.
grantedRoles number[]
The list of existing unique identifiers for the granted roles.
name string
The name you supply for a role.
type string
The role type which indicates whether it's a standard role provided by Akamai or a custom role for the account.
description str
The description for a role.
granted_roles Sequence[int]
The list of existing unique identifiers for the granted roles.
name str
The name you supply for a role.
type str
The role type which indicates whether it's a standard role provided by Akamai or a custom role for the account.
description String
The description for a role.
grantedRoles List<Number>
The list of existing unique identifiers for the granted roles.
name String
The name you supply for a role.
type String
The role type which indicates whether it's a standard role provided by Akamai or a custom role for the account.

Package Details

Repository
Akamai pulumi/pulumi-akamai
License
Apache-2.0
Notes
This Pulumi package is based on the akamai Terraform Provider.
Akamai v8.1.0 published on Friday, Apr 11, 2025 by Pulumi
pulumi/pulumi-akamai