Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Akeyless Provider
  3. API Docs
  4. AuthMethodAwsIam
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
akeyless-community/terraform-provider-akeyless

akeyless.AuthMethodAwsIam

Explore with Pulumi AI

akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
akeyless-community/terraform-provider-akeyless

AWS IAM Auth Method Resource

Create AuthMethodAwsIam Resource

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

Constructor syntax

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

@overload
def AuthMethodAwsIam(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     bound_aws_account_ids: Optional[Sequence[str]] = None,
                     bound_role_names: Optional[Sequence[str]] = None,
                     delete_protection: Optional[str] = None,
                     bound_arns: Optional[Sequence[str]] = None,
                     audit_logs_claims: Optional[Sequence[str]] = None,
                     bound_ips: Optional[Sequence[str]] = None,
                     bound_resource_ids: Optional[Sequence[str]] = None,
                     auth_method_aws_iam_id: Optional[str] = None,
                     bound_user_ids: Optional[Sequence[str]] = None,
                     bound_role_ids: Optional[Sequence[str]] = None,
                     bound_user_names: Optional[Sequence[str]] = None,
                     access_expires: Optional[float] = None,
                     force_sub_claims: Optional[bool] = None,
                     jwt_ttl: Optional[float] = None,
                     name: Optional[str] = None,
                     sts_url: Optional[str] = None)
func NewAuthMethodAwsIam(ctx *Context, name string, args AuthMethodAwsIamArgs, opts ...ResourceOption) (*AuthMethodAwsIam, error)
public AuthMethodAwsIam(string name, AuthMethodAwsIamArgs args, CustomResourceOptions? opts = null)
public AuthMethodAwsIam(String name, AuthMethodAwsIamArgs args)
public AuthMethodAwsIam(String name, AuthMethodAwsIamArgs args, CustomResourceOptions options)

type: akeyless:AuthMethodAwsIam
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. AuthMethodAwsIamArgs
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. AuthMethodAwsIamInitArgs
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. AuthMethodAwsIamArgs
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. AuthMethodAwsIamArgs
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. AuthMethodAwsIamArgs
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 authMethodAwsIamResource = new Akeyless.AuthMethodAwsIam("authMethodAwsIamResource", new()
{
    BoundAwsAccountIds = new[]
    {
        "string",
    },
    BoundRoleNames = new[]
    {
        "string",
    },
    DeleteProtection = "string",
    BoundArns = new[]
    {
        "string",
    },
    AuditLogsClaims = new[]
    {
        "string",
    },
    BoundIps = new[]
    {
        "string",
    },
    BoundResourceIds = new[]
    {
        "string",
    },
    AuthMethodAwsIamId = "string",
    BoundUserIds = new[]
    {
        "string",
    },
    BoundRoleIds = new[]
    {
        "string",
    },
    BoundUserNames = new[]
    {
        "string",
    },
    AccessExpires = 0,
    ForceSubClaims = false,
    JwtTtl = 0,
    Name = "string",
    StsUrl = "string",
});
Copy
example, err := akeyless.NewAuthMethodAwsIam(ctx, "authMethodAwsIamResource", &akeyless.AuthMethodAwsIamArgs{
BoundAwsAccountIds: pulumi.StringArray{
pulumi.String("string"),
},
BoundRoleNames: pulumi.StringArray{
pulumi.String("string"),
},
DeleteProtection: pulumi.String("string"),
BoundArns: pulumi.StringArray{
pulumi.String("string"),
},
AuditLogsClaims: pulumi.StringArray{
pulumi.String("string"),
},
BoundIps: pulumi.StringArray{
pulumi.String("string"),
},
BoundResourceIds: pulumi.StringArray{
pulumi.String("string"),
},
AuthMethodAwsIamId: pulumi.String("string"),
BoundUserIds: pulumi.StringArray{
pulumi.String("string"),
},
BoundRoleIds: pulumi.StringArray{
pulumi.String("string"),
},
BoundUserNames: pulumi.StringArray{
pulumi.String("string"),
},
AccessExpires: pulumi.Float64(0),
ForceSubClaims: pulumi.Bool(false),
JwtTtl: pulumi.Float64(0),
Name: pulumi.String("string"),
StsUrl: pulumi.String("string"),
})
Copy
var authMethodAwsIamResource = new AuthMethodAwsIam("authMethodAwsIamResource", AuthMethodAwsIamArgs.builder()
    .boundAwsAccountIds("string")
    .boundRoleNames("string")
    .deleteProtection("string")
    .boundArns("string")
    .auditLogsClaims("string")
    .boundIps("string")
    .boundResourceIds("string")
    .authMethodAwsIamId("string")
    .boundUserIds("string")
    .boundRoleIds("string")
    .boundUserNames("string")
    .accessExpires(0)
    .forceSubClaims(false)
    .jwtTtl(0)
    .name("string")
    .stsUrl("string")
    .build());
Copy
auth_method_aws_iam_resource = akeyless.AuthMethodAwsIam("authMethodAwsIamResource",
    bound_aws_account_ids=["string"],
    bound_role_names=["string"],
    delete_protection="string",
    bound_arns=["string"],
    audit_logs_claims=["string"],
    bound_ips=["string"],
    bound_resource_ids=["string"],
    auth_method_aws_iam_id="string",
    bound_user_ids=["string"],
    bound_role_ids=["string"],
    bound_user_names=["string"],
    access_expires=0,
    force_sub_claims=False,
    jwt_ttl=0,
    name="string",
    sts_url="string")
Copy
const authMethodAwsIamResource = new akeyless.AuthMethodAwsIam("authMethodAwsIamResource", {
    boundAwsAccountIds: ["string"],
    boundRoleNames: ["string"],
    deleteProtection: "string",
    boundArns: ["string"],
    auditLogsClaims: ["string"],
    boundIps: ["string"],
    boundResourceIds: ["string"],
    authMethodAwsIamId: "string",
    boundUserIds: ["string"],
    boundRoleIds: ["string"],
    boundUserNames: ["string"],
    accessExpires: 0,
    forceSubClaims: false,
    jwtTtl: 0,
    name: "string",
    stsUrl: "string",
});
Copy
type: akeyless:AuthMethodAwsIam
properties:
    accessExpires: 0
    auditLogsClaims:
        - string
    authMethodAwsIamId: string
    boundArns:
        - string
    boundAwsAccountIds:
        - string
    boundIps:
        - string
    boundResourceIds:
        - string
    boundRoleIds:
        - string
    boundRoleNames:
        - string
    boundUserIds:
        - string
    boundUserNames:
        - string
    deleteProtection: string
    forceSubClaims: false
    jwtTtl: 0
    name: string
    stsUrl: string
Copy

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

BoundAwsAccountIds This property is required. List<string>
A list of AWS account-IDs that the access is restricted to
AccessExpires double
Access expiration date in Unix timestamp (select 0 for access without expiry date)
AuditLogsClaims List<string>
Subclaims to include in audit logs
AuthMethodAwsIamId string
The ID of this resource.
BoundArns List<string>
A list of full arns that the access is restricted to
BoundIps List<string>
A CIDR whitelist with the IPs that the access is restricted to
BoundResourceIds List<string>
A list of full resource ids that the access is restricted to
BoundRoleIds List<string>
A list of full role ids that the access is restricted to
BoundRoleNames List<string>
A list of full role-name that the access is restricted to
BoundUserIds List<string>
A list of full user ids that the access is restricted to
BoundUserNames List<string>
A list of full user-name that the access is restricted to
DeleteProtection string
Protection from accidental deletion of this auth method, [true/false]
ForceSubClaims bool
enforce role-association must include sub claims
JwtTtl double
Creds expiration time in minutes
Name string
Auth Method name
StsUrl string
sts URL
BoundAwsAccountIds This property is required. []string
A list of AWS account-IDs that the access is restricted to
AccessExpires float64
Access expiration date in Unix timestamp (select 0 for access without expiry date)
AuditLogsClaims []string
Subclaims to include in audit logs
AuthMethodAwsIamId string
The ID of this resource.
BoundArns []string
A list of full arns that the access is restricted to
BoundIps []string
A CIDR whitelist with the IPs that the access is restricted to
BoundResourceIds []string
A list of full resource ids that the access is restricted to
BoundRoleIds []string
A list of full role ids that the access is restricted to
BoundRoleNames []string
A list of full role-name that the access is restricted to
BoundUserIds []string
A list of full user ids that the access is restricted to
BoundUserNames []string
A list of full user-name that the access is restricted to
DeleteProtection string
Protection from accidental deletion of this auth method, [true/false]
ForceSubClaims bool
enforce role-association must include sub claims
JwtTtl float64
Creds expiration time in minutes
Name string
Auth Method name
StsUrl string
sts URL
boundAwsAccountIds This property is required. List<String>
A list of AWS account-IDs that the access is restricted to
accessExpires Double
Access expiration date in Unix timestamp (select 0 for access without expiry date)
auditLogsClaims List<String>
Subclaims to include in audit logs
authMethodAwsIamId String
The ID of this resource.
boundArns List<String>
A list of full arns that the access is restricted to
boundIps List<String>
A CIDR whitelist with the IPs that the access is restricted to
boundResourceIds List<String>
A list of full resource ids that the access is restricted to
boundRoleIds List<String>
A list of full role ids that the access is restricted to
boundRoleNames List<String>
A list of full role-name that the access is restricted to
boundUserIds List<String>
A list of full user ids that the access is restricted to
boundUserNames List<String>
A list of full user-name that the access is restricted to
deleteProtection String
Protection from accidental deletion of this auth method, [true/false]
forceSubClaims Boolean
enforce role-association must include sub claims
jwtTtl Double
Creds expiration time in minutes
name String
Auth Method name
stsUrl String
sts URL
boundAwsAccountIds This property is required. string[]
A list of AWS account-IDs that the access is restricted to
accessExpires number
Access expiration date in Unix timestamp (select 0 for access without expiry date)
auditLogsClaims string[]
Subclaims to include in audit logs
authMethodAwsIamId string
The ID of this resource.
boundArns string[]
A list of full arns that the access is restricted to
boundIps string[]
A CIDR whitelist with the IPs that the access is restricted to
boundResourceIds string[]
A list of full resource ids that the access is restricted to
boundRoleIds string[]
A list of full role ids that the access is restricted to
boundRoleNames string[]
A list of full role-name that the access is restricted to
boundUserIds string[]
A list of full user ids that the access is restricted to
boundUserNames string[]
A list of full user-name that the access is restricted to
deleteProtection string
Protection from accidental deletion of this auth method, [true/false]
forceSubClaims boolean
enforce role-association must include sub claims
jwtTtl number
Creds expiration time in minutes
name string
Auth Method name
stsUrl string
sts URL
bound_aws_account_ids This property is required. Sequence[str]
A list of AWS account-IDs that the access is restricted to
access_expires float
Access expiration date in Unix timestamp (select 0 for access without expiry date)
audit_logs_claims Sequence[str]
Subclaims to include in audit logs
auth_method_aws_iam_id str
The ID of this resource.
bound_arns Sequence[str]
A list of full arns that the access is restricted to
bound_ips Sequence[str]
A CIDR whitelist with the IPs that the access is restricted to
bound_resource_ids Sequence[str]
A list of full resource ids that the access is restricted to
bound_role_ids Sequence[str]
A list of full role ids that the access is restricted to
bound_role_names Sequence[str]
A list of full role-name that the access is restricted to
bound_user_ids Sequence[str]
A list of full user ids that the access is restricted to
bound_user_names Sequence[str]
A list of full user-name that the access is restricted to
delete_protection str
Protection from accidental deletion of this auth method, [true/false]
force_sub_claims bool
enforce role-association must include sub claims
jwt_ttl float
Creds expiration time in minutes
name str
Auth Method name
sts_url str
sts URL
boundAwsAccountIds This property is required. List<String>
A list of AWS account-IDs that the access is restricted to
accessExpires Number
Access expiration date in Unix timestamp (select 0 for access without expiry date)
auditLogsClaims List<String>
Subclaims to include in audit logs
authMethodAwsIamId String
The ID of this resource.
boundArns List<String>
A list of full arns that the access is restricted to
boundIps List<String>
A CIDR whitelist with the IPs that the access is restricted to
boundResourceIds List<String>
A list of full resource ids that the access is restricted to
boundRoleIds List<String>
A list of full role ids that the access is restricted to
boundRoleNames List<String>
A list of full role-name that the access is restricted to
boundUserIds List<String>
A list of full user ids that the access is restricted to
boundUserNames List<String>
A list of full user-name that the access is restricted to
deleteProtection String
Protection from accidental deletion of this auth method, [true/false]
forceSubClaims Boolean
enforce role-association must include sub claims
jwtTtl Number
Creds expiration time in minutes
name String
Auth Method name
stsUrl String
sts URL

Outputs

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

AccessId string
Auth Method access ID
Id string
The provider-assigned unique ID for this managed resource.
AccessId string
Auth Method access ID
Id string
The provider-assigned unique ID for this managed resource.
accessId String
Auth Method access ID
id String
The provider-assigned unique ID for this managed resource.
accessId string
Auth Method access ID
id string
The provider-assigned unique ID for this managed resource.
access_id str
Auth Method access ID
id str
The provider-assigned unique ID for this managed resource.
accessId String
Auth Method access ID
id String
The provider-assigned unique ID for this managed resource.

Look up Existing AuthMethodAwsIam Resource

Get an existing AuthMethodAwsIam 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?: AuthMethodAwsIamState, opts?: CustomResourceOptions): AuthMethodAwsIam
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_expires: Optional[float] = None,
        access_id: Optional[str] = None,
        audit_logs_claims: Optional[Sequence[str]] = None,
        auth_method_aws_iam_id: Optional[str] = None,
        bound_arns: Optional[Sequence[str]] = None,
        bound_aws_account_ids: Optional[Sequence[str]] = None,
        bound_ips: Optional[Sequence[str]] = None,
        bound_resource_ids: Optional[Sequence[str]] = None,
        bound_role_ids: Optional[Sequence[str]] = None,
        bound_role_names: Optional[Sequence[str]] = None,
        bound_user_ids: Optional[Sequence[str]] = None,
        bound_user_names: Optional[Sequence[str]] = None,
        delete_protection: Optional[str] = None,
        force_sub_claims: Optional[bool] = None,
        jwt_ttl: Optional[float] = None,
        name: Optional[str] = None,
        sts_url: Optional[str] = None) -> AuthMethodAwsIam
func GetAuthMethodAwsIam(ctx *Context, name string, id IDInput, state *AuthMethodAwsIamState, opts ...ResourceOption) (*AuthMethodAwsIam, error)
public static AuthMethodAwsIam Get(string name, Input<string> id, AuthMethodAwsIamState? state, CustomResourceOptions? opts = null)
public static AuthMethodAwsIam get(String name, Output<String> id, AuthMethodAwsIamState state, CustomResourceOptions options)
resources:  _:    type: akeyless:AuthMethodAwsIam    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:
AccessExpires double
Access expiration date in Unix timestamp (select 0 for access without expiry date)
AccessId string
Auth Method access ID
AuditLogsClaims List<string>
Subclaims to include in audit logs
AuthMethodAwsIamId string
The ID of this resource.
BoundArns List<string>
A list of full arns that the access is restricted to
BoundAwsAccountIds List<string>
A list of AWS account-IDs that the access is restricted to
BoundIps List<string>
A CIDR whitelist with the IPs that the access is restricted to
BoundResourceIds List<string>
A list of full resource ids that the access is restricted to
BoundRoleIds List<string>
A list of full role ids that the access is restricted to
BoundRoleNames List<string>
A list of full role-name that the access is restricted to
BoundUserIds List<string>
A list of full user ids that the access is restricted to
BoundUserNames List<string>
A list of full user-name that the access is restricted to
DeleteProtection string
Protection from accidental deletion of this auth method, [true/false]
ForceSubClaims bool
enforce role-association must include sub claims
JwtTtl double
Creds expiration time in minutes
Name string
Auth Method name
StsUrl string
sts URL
AccessExpires float64
Access expiration date in Unix timestamp (select 0 for access without expiry date)
AccessId string
Auth Method access ID
AuditLogsClaims []string
Subclaims to include in audit logs
AuthMethodAwsIamId string
The ID of this resource.
BoundArns []string
A list of full arns that the access is restricted to
BoundAwsAccountIds []string
A list of AWS account-IDs that the access is restricted to
BoundIps []string
A CIDR whitelist with the IPs that the access is restricted to
BoundResourceIds []string
A list of full resource ids that the access is restricted to
BoundRoleIds []string
A list of full role ids that the access is restricted to
BoundRoleNames []string
A list of full role-name that the access is restricted to
BoundUserIds []string
A list of full user ids that the access is restricted to
BoundUserNames []string
A list of full user-name that the access is restricted to
DeleteProtection string
Protection from accidental deletion of this auth method, [true/false]
ForceSubClaims bool
enforce role-association must include sub claims
JwtTtl float64
Creds expiration time in minutes
Name string
Auth Method name
StsUrl string
sts URL
accessExpires Double
Access expiration date in Unix timestamp (select 0 for access without expiry date)
accessId String
Auth Method access ID
auditLogsClaims List<String>
Subclaims to include in audit logs
authMethodAwsIamId String
The ID of this resource.
boundArns List<String>
A list of full arns that the access is restricted to
boundAwsAccountIds List<String>
A list of AWS account-IDs that the access is restricted to
boundIps List<String>
A CIDR whitelist with the IPs that the access is restricted to
boundResourceIds List<String>
A list of full resource ids that the access is restricted to
boundRoleIds List<String>
A list of full role ids that the access is restricted to
boundRoleNames List<String>
A list of full role-name that the access is restricted to
boundUserIds List<String>
A list of full user ids that the access is restricted to
boundUserNames List<String>
A list of full user-name that the access is restricted to
deleteProtection String
Protection from accidental deletion of this auth method, [true/false]
forceSubClaims Boolean
enforce role-association must include sub claims
jwtTtl Double
Creds expiration time in minutes
name String
Auth Method name
stsUrl String
sts URL
accessExpires number
Access expiration date in Unix timestamp (select 0 for access without expiry date)
accessId string
Auth Method access ID
auditLogsClaims string[]
Subclaims to include in audit logs
authMethodAwsIamId string
The ID of this resource.
boundArns string[]
A list of full arns that the access is restricted to
boundAwsAccountIds string[]
A list of AWS account-IDs that the access is restricted to
boundIps string[]
A CIDR whitelist with the IPs that the access is restricted to
boundResourceIds string[]
A list of full resource ids that the access is restricted to
boundRoleIds string[]
A list of full role ids that the access is restricted to
boundRoleNames string[]
A list of full role-name that the access is restricted to
boundUserIds string[]
A list of full user ids that the access is restricted to
boundUserNames string[]
A list of full user-name that the access is restricted to
deleteProtection string
Protection from accidental deletion of this auth method, [true/false]
forceSubClaims boolean
enforce role-association must include sub claims
jwtTtl number
Creds expiration time in minutes
name string
Auth Method name
stsUrl string
sts URL
access_expires float
Access expiration date in Unix timestamp (select 0 for access without expiry date)
access_id str
Auth Method access ID
audit_logs_claims Sequence[str]
Subclaims to include in audit logs
auth_method_aws_iam_id str
The ID of this resource.
bound_arns Sequence[str]
A list of full arns that the access is restricted to
bound_aws_account_ids Sequence[str]
A list of AWS account-IDs that the access is restricted to
bound_ips Sequence[str]
A CIDR whitelist with the IPs that the access is restricted to
bound_resource_ids Sequence[str]
A list of full resource ids that the access is restricted to
bound_role_ids Sequence[str]
A list of full role ids that the access is restricted to
bound_role_names Sequence[str]
A list of full role-name that the access is restricted to
bound_user_ids Sequence[str]
A list of full user ids that the access is restricted to
bound_user_names Sequence[str]
A list of full user-name that the access is restricted to
delete_protection str
Protection from accidental deletion of this auth method, [true/false]
force_sub_claims bool
enforce role-association must include sub claims
jwt_ttl float
Creds expiration time in minutes
name str
Auth Method name
sts_url str
sts URL
accessExpires Number
Access expiration date in Unix timestamp (select 0 for access without expiry date)
accessId String
Auth Method access ID
auditLogsClaims List<String>
Subclaims to include in audit logs
authMethodAwsIamId String
The ID of this resource.
boundArns List<String>
A list of full arns that the access is restricted to
boundAwsAccountIds List<String>
A list of AWS account-IDs that the access is restricted to
boundIps List<String>
A CIDR whitelist with the IPs that the access is restricted to
boundResourceIds List<String>
A list of full resource ids that the access is restricted to
boundRoleIds List<String>
A list of full role ids that the access is restricted to
boundRoleNames List<String>
A list of full role-name that the access is restricted to
boundUserIds List<String>
A list of full user ids that the access is restricted to
boundUserNames List<String>
A list of full user-name that the access is restricted to
deleteProtection String
Protection from accidental deletion of this auth method, [true/false]
forceSubClaims Boolean
enforce role-association must include sub claims
jwtTtl Number
Creds expiration time in minutes
name String
Auth Method name
stsUrl String
sts URL

Package Details

Repository
akeyless akeyless-community/terraform-provider-akeyless
License
Notes
This Pulumi package is based on the akeyless Terraform Provider.
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
akeyless-community/terraform-provider-akeyless