commonMain.aws.sdk.kotlin.services.iam.model.CreateRoleRequest.kt Maven / Gradle / Ivy
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.iam.model
public class CreateRoleRequest private constructor(builder: Builder) {
/**
* The trust relationship policy document that grants an entity permission to assume the role.
*
* In IAM, you must provide a JSON policy that has been converted to a string. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
*
* The [regex pattern](http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:
* + Any printable ASCII character ranging from the space character (`\u0020`) through the end of the ASCII character range
* + The printable characters in the Basic Latin and Latin-1 Supplement character set (through `\u00FF`)
* + The special characters tab (`\u0009`), line feed (`\u000A`), and carriage return (`\u000D`)
*
* Upon success, the response includes the same trust policy in JSON format.
*/
public val assumeRolePolicyDocument: kotlin.String? = builder.assumeRolePolicyDocument
/**
* A description of the role.
*/
public val description: kotlin.String? = builder.description
/**
* The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.
*
* Anyone who assumes the role from the CLI or API can use the `DurationSeconds` API parameter or the `duration-seconds` CLI parameter to request a longer session. The `MaxSessionDuration` setting determines the maximum duration that can be requested using the `DurationSeconds` parameter. If users don't specify a value for the `DurationSeconds` parameter, their security credentials are valid for one hour by default. This applies when you use the `AssumeRole*` API operations or the `assume-role*` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*.
*/
public val maxSessionDuration: kotlin.Int? = builder.maxSessionDuration
/**
* The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.
*
* This parameter is optional. If it is not included, it defaults to a slash (/).
*
* This parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (`\u0021`) through the DEL character (`\u007F`), including most punctuation characters, digits, and upper and lowercased letters.
*/
public val path: kotlin.String? = builder.path
/**
* The ARN of the managed policy that is used to set the permissions boundary for the role.
*
* A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.
*
* For more information about policy types, see [Policy types ](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*.
*/
public val permissionsBoundary: kotlin.String? = builder.permissionsBoundary
/**
* The name of the role to create.
*
* IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
*
* This parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
*/
public val roleName: kotlin.String? = builder.roleName
/**
* A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
*/
public val tags: List? = builder.tags
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.iam.model.CreateRoleRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("CreateRoleRequest(")
append("assumeRolePolicyDocument=$assumeRolePolicyDocument,")
append("description=$description,")
append("maxSessionDuration=$maxSessionDuration,")
append("path=$path,")
append("permissionsBoundary=$permissionsBoundary,")
append("roleName=$roleName,")
append("tags=$tags")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = assumeRolePolicyDocument?.hashCode() ?: 0
result = 31 * result + (description?.hashCode() ?: 0)
result = 31 * result + (maxSessionDuration ?: 0)
result = 31 * result + (path?.hashCode() ?: 0)
result = 31 * result + (permissionsBoundary?.hashCode() ?: 0)
result = 31 * result + (roleName?.hashCode() ?: 0)
result = 31 * result + (tags?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as CreateRoleRequest
if (assumeRolePolicyDocument != other.assumeRolePolicyDocument) return false
if (description != other.description) return false
if (maxSessionDuration != other.maxSessionDuration) return false
if (path != other.path) return false
if (permissionsBoundary != other.permissionsBoundary) return false
if (roleName != other.roleName) return false
if (tags != other.tags) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.iam.model.CreateRoleRequest = Builder(this).apply(block).build()
public class Builder {
/**
* The trust relationship policy document that grants an entity permission to assume the role.
*
* In IAM, you must provide a JSON policy that has been converted to a string. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
*
* The [regex pattern](http://wikipedia.org/wiki/regex) used to validate this parameter is a string of characters consisting of the following:
* + Any printable ASCII character ranging from the space character (`\u0020`) through the end of the ASCII character range
* + The printable characters in the Basic Latin and Latin-1 Supplement character set (through `\u00FF`)
* + The special characters tab (`\u0009`), line feed (`\u000A`), and carriage return (`\u000D`)
*
* Upon success, the response includes the same trust policy in JSON format.
*/
public var assumeRolePolicyDocument: kotlin.String? = null
/**
* A description of the role.
*/
public var description: kotlin.String? = null
/**
* The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours.
*
* Anyone who assumes the role from the CLI or API can use the `DurationSeconds` API parameter or the `duration-seconds` CLI parameter to request a longer session. The `MaxSessionDuration` setting determines the maximum duration that can be requested using the `DurationSeconds` parameter. If users don't specify a value for the `DurationSeconds` parameter, their security credentials are valid for one hour by default. This applies when you use the `AssumeRole*` API operations or the `assume-role*` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*.
*/
public var maxSessionDuration: kotlin.Int? = null
/**
* The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.
*
* This parameter is optional. If it is not included, it defaults to a slash (/).
*
* This parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (`\u0021`) through the DEL character (`\u007F`), including most punctuation characters, digits, and upper and lowercased letters.
*/
public var path: kotlin.String? = null
/**
* The ARN of the managed policy that is used to set the permissions boundary for the role.
*
* A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.
*
* For more information about policy types, see [Policy types ](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*.
*/
public var permissionsBoundary: kotlin.String? = null
/**
* The name of the role to create.
*
* IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".
*
* This parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
*/
public var roleName: kotlin.String? = null
/**
* A list of tags that you want to attach to the new role. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
*/
public var tags: List? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.iam.model.CreateRoleRequest) : this() {
this.assumeRolePolicyDocument = x.assumeRolePolicyDocument
this.description = x.description
this.maxSessionDuration = x.maxSessionDuration
this.path = x.path
this.permissionsBoundary = x.permissionsBoundary
this.roleName = x.roleName
this.tags = x.tags
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.iam.model.CreateRoleRequest = CreateRoleRequest(this)
internal fun correctErrors(): Builder {
return this
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy