Package software.amazon.awscdk.services.iam

Class CfnPolicyProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • policyDocument

      @Stability(Stable) public CfnPolicyProps.Builder policyDocument(Object policyDocument)
      Sets the value of CfnPolicyProps.getPolicyDocument()
      Parameters:
      policyDocument - The policy document. This parameter is required. You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

      The regex pattern 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 )
      Returns:
      this

    • policyName

      @Stability(Stable) public CfnPolicyProps.Builder policyName(String policyName)
      Sets the value of CfnPolicyProps.getPolicyName()
      Parameters:
      policyName - The name of the policy document. This parameter is required. This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
      Returns:
      this

    • groups

      @Stability(Stable) public CfnPolicyProps.Builder groups(List<String> groups)
      Sets the value of CfnPolicyProps.getGroups()
      Parameters:
      groups - The name of the group to associate the policy with. This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.
      Returns:
      this

    • roles

      @Stability(Stable) public CfnPolicyProps.Builder roles(List<String> roles)
      Sets the value of CfnPolicyProps.getRoles()
      Parameters:
      roles - The name of the role to associate the policy with. This parameter allows (per its regex pattern ) 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 AWS CloudFormation deletes the AWS::ECS::Service resource before deleting its role's policy.

      Returns:
      this

    • users

      @Stability(Stable) public CfnPolicyProps.Builder users(List<String> users)
      Sets the value of CfnPolicyProps.getUsers()
      Parameters:
      users - The name of the user to associate the policy with. This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
      Returns:
      this

    • build

      @Stability(Stable) public CfnPolicyProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnPolicyProps>
      Returns:
      a new instance of CfnPolicyProps
      Throws:
      NullPointerException - if any required attribute was not provided