Package software.amazon.awscdk.services.iam

Class Policy.Builder

java.lang.Object
software.amazon.awscdk.services.iam.Policy.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<Policy>
Enclosing class:
Policy
@Stability(Stable) public static final class Policy.Builder extends Object implements software.amazon.jsii.Builder<Policy>
A fluent builder for Policy.

  • Method Details

    • create

      @Stability(Stable) public static Policy.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of Policy.Builder.

    • document

      @Stability(Stable) public Policy.Builder document(PolicyDocument document)
      Initial PolicyDocument to use for this Policy.

      If omited, any PolicyStatement provided in the statements property will be applied against the empty default PolicyDocument.

      Default: - An empty policy.

      Parameters:
      document - Initial PolicyDocument to use for this Policy. This parameter is required.
      Returns:
      this

    • force

      @Stability(Stable) public Policy.Builder force(Boolean force)
      Force creation of an AWS::IAM::Policy.

      Unless set to true, this Policy construct will not materialize to an AWS::IAM::Policy CloudFormation resource in case it would have no effect (for example, if it remains unattached to an IAM identity or if it has no statements). This is generally desired behavior, since it prevents creating invalid--and hence undeployable--CloudFormation templates.

      In cases where you know the policy must be created and it is actually an error if no statements have been added to it or it remains unattached to an IAM identity, you can set this to true.

      Default: false

      Parameters:
      force - Force creation of an AWS::IAM::Policy. This parameter is required.
      Returns:
      this

    • groups

      @Stability(Stable) public Policy.Builder groups(List<? extends IGroup> groups)
      Groups to attach this policy to.

      You can also use attachToGroup(group) to attach this policy to a group.

      Default: - No groups.

      Parameters:
      groups - Groups to attach this policy to. This parameter is required.
      Returns:
      this

    • policyName

      @Stability(Stable) public Policy.Builder policyName(String policyName)
      The name of the policy.

      If you specify multiple policies for an entity, specify unique names. For example, if you specify a list of policies for an IAM role, each policy must have a unique name.

      Default: - Uses the logical ID of the policy resource, which is ensured to be unique within the stack.

      Parameters:
      policyName - The name of the policy. This parameter is required.
      Returns:
      this

    • roles

      @Stability(Stable) public Policy.Builder roles(List<? extends IRole> roles)
      Roles to attach this policy to.

      You can also use attachToRole(role) to attach this policy to a role.

      Default: - No roles.

      Parameters:
      roles - Roles to attach this policy to. This parameter is required.
      Returns:
      this

    • statements

      @Stability(Stable) public Policy.Builder statements(List<? extends PolicyStatement> statements)
      Initial set of permissions to add to this policy document.

      You can also use addStatements(...statement) to add permissions later.

      Default: - No statements.

      Parameters:
      statements - Initial set of permissions to add to this policy document. This parameter is required.
      Returns:
      this

    • users

      @Stability(Stable) public Policy.Builder users(List<? extends IUser> users)
      Users to attach this policy to.

      You can also use attachToUser(user) to attach this policy to a user.

      Default: - No users.

      Parameters:
      users - Users to attach this policy to. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public Policy build()
      Specified by:
      build in interface software.amazon.jsii.Builder<Policy>
      Returns:
      a newly built instance of Policy.