com.pulumi.awsnative.iam.kotlin.ManagedPolicy.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation
Show all versions of pulumi-aws-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.iam.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Any
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
/**
* Builder for [ManagedPolicy].
*/
@PulumiTagMarker
public class ManagedPolicyResourceBuilder internal constructor() {
public var name: String? = null
public var args: ManagedPolicyArgs = ManagedPolicyArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend ManagedPolicyArgsBuilder.() -> Unit) {
val builder = ManagedPolicyArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): ManagedPolicy {
val builtJavaResource = com.pulumi.awsnative.iam.ManagedPolicy(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return ManagedPolicy(builtJavaResource)
}
}
/**
* Creates a new managed policy for your AWS-account.
* This operation creates a policy version with a version identifier of ``v1`` and sets v1 as the policy's default version. For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide*.
* As a best practice, you can validate your IAM policies. To learn more, see [Validating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_policy-validator.html) in the *IAM User Guide*.
* For more information about managed policies in general, see [Managed policies and inline policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *IAM User Guide*.
*/
public class ManagedPolicy internal constructor(
override val javaResource: com.pulumi.awsnative.iam.ManagedPolicy,
) : KotlinCustomResource(javaResource, ManagedPolicyMapper) {
/**
* The number of principal entities (users, groups, and roles) that the policy is attached to.
*/
public val attachmentCount: Output
get() = javaResource.attachmentCount().applyValue({ args0 -> args0 })
/**
* The date and time, in [ISO 8601 date-time format](https://docs.aws.amazon.com/http://www.iso.org/iso/iso8601) , when the policy was created.
*/
public val createDate: Output
get() = javaResource.createDate().applyValue({ args0 -> args0 })
/**
* The identifier for the version of the policy that is set as the default (operative) version.
* For more information about policy versions, see [Versioning for managed policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) in the *IAM User Guide* .
*/
public val defaultVersionId: Output
get() = javaResource.defaultVersionId().applyValue({ args0 -> args0 })
/**
* A friendly description of the policy.
* Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."
* The policy description is immutable. After a value is assigned, it cannot be changed.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The name (friendly name, not ARN) of the group to attach the policy to.
* This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/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 groups: Output>?
get() = javaResource.groups().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
/**
* Specifies whether the policy can be attached to an IAM user, group, or role.
*/
public val isAttachable: Output
get() = javaResource.isAttachable().applyValue({ args0 -> args0 })
/**
* The friendly name of the policy.
* If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
* If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).
* Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``.
*/
public val managedPolicyName: Output?
get() = javaResource.managedPolicyName().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The path for the policy.
* 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](https://docs.aws.amazon.com/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.
* You cannot use an asterisk (*) in the path name.
*/
public val path: Output?
get() = javaResource.path().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The number of entities (users and roles) for which the policy is used as the permissions boundary.
* For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide* .
*/
public val permissionsBoundaryUsageCount: Output
get() = javaResource.permissionsBoundaryUsageCount().applyValue({ args0 -> args0 })
public val policyArn: Output
get() = javaResource.policyArn().applyValue({ args0 -> args0 })
/**
* The JSON policy document that you want to use as the content for the new policy.
* You must provide policies in JSON format in IAM. However, for CFN templates formatted in YAML, you can provide the policy in JSON or YAML format. CFN always converts a YAML policy to JSON format before submitting it to IAM.
* The maximum length of the policy document that you can pass in this operation, including whitespace, is listed below. To view the maximum character counts of a managed policy with no whitespaces, see [IAM and character quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length).
* To learn more about JSON policy grammar, see [Grammar of the IAM JSON policy language](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html) in the *IAM User Guide*.
* The [regex pattern](https://docs.aws.amazon.com/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``)
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::IAM::ManagedPolicy` for more information about the expected schema for this property.
*/
public val policyDocument: Output
get() = javaResource.policyDocument().applyValue({ args0 -> args0 })
/**
* The stable and unique string identifying the policy.
* For more information about IDs, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide* .
*/
public val policyId: Output
get() = javaResource.policyId().applyValue({ args0 -> args0 })
/**
* The name (friendly name, not ARN) of the role to attach the policy to.
* This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/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: _+=,.@-
* If an external policy (such as ``AWS::IAM::Policy`` or ``AWS::IAM::ManagedPolicy``) has a ``Ref`` to a role and if a resource (such as ``AWS::ECS::Service``) also has a ``Ref`` to the same role, add a ``DependsOn`` attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an ``AWS::ECS::Service`` resource, the ``DependsOn`` attribute ensures that CFN deletes the ``AWS::ECS::Service`` resource before deleting its role's policy.
*/
public val roles: Output>?
get() = javaResource.roles().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
/**
* The date and time, in [ISO 8601 date-time format](https://docs.aws.amazon.com/http://www.iso.org/iso/iso8601) , when the policy was last updated.
* When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.
*/
public val updateDate: Output
get() = javaResource.updateDate().applyValue({ args0 -> args0 })
/**
* The name (friendly name, not ARN) of the IAM user to attach the policy to.
* This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/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 users: Output>?
get() = javaResource.users().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
}
public object ManagedPolicyMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.awsnative.iam.ManagedPolicy::class == javaResource::class
override fun map(javaResource: Resource): ManagedPolicy = ManagedPolicy(
javaResource as
com.pulumi.awsnative.iam.ManagedPolicy,
)
}
/**
* @see [ManagedPolicy].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [ManagedPolicy].
*/
public suspend fun managedPolicy(
name: String,
block: suspend ManagedPolicyResourceBuilder.() -> Unit,
): ManagedPolicy {
val builder = ManagedPolicyResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [ManagedPolicy].
* @param name The _unique_ name of the resulting resource.
*/
public fun managedPolicy(name: String): ManagedPolicy {
val builder = ManagedPolicyResourceBuilder()
builder.name(name)
return builder.build()
}