Class CfnPermissionProps.Builder

java.lang.Object
software.amazon.awscdk.services.ram.CfnPermissionProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnPermissionProps>
Enclosing interface:
CfnPermissionProps

@Stability(Stable) public static final class CfnPermissionProps.Builder extends Object implements software.amazon.jsii.Builder<CfnPermissionProps>
A builder for CfnPermissionProps
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • name

      @Stability(Stable) public CfnPermissionProps.Builder name(String name)
      Parameters:
      name - Specifies the name of the customer managed permission. This parameter is required. The name must be unique within the AWS Region .
      Returns:
      this
    • policyTemplate

      @Stability(Stable) public CfnPermissionProps.Builder policyTemplate(Object policyTemplate)
      Parameters:
      policyTemplate - A string in JSON format string that contains the following elements of a resource-based policy:. This parameter is required.
      • Effect : must be set to ALLOW .
      • Action : specifies the actions that are allowed by this customer managed permission. The list must contain only actions that are supported by the specified resource type. For a list of all actions supported by each resource type, see Actions, resources, and condition keys for AWS services in the AWS Identity and Access Management User Guide .
      • Condition : (optional) specifies conditional parameters that must evaluate to true when a user attempts an action for that action to be allowed. For more information about the Condition element, see IAM policies: Condition element in the AWS Identity and Access Management User Guide .

      This template can't include either the Resource or Principal elements. Those are both filled in by AWS RAM when it instantiates the resource-based policy on each resource shared using this managed permission. The Resource comes from the ARN of the specific resource that you are sharing. The Principal comes from the list of identities added to the resource share.

      Returns:
      this
    • resourceType

      @Stability(Stable) public CfnPermissionProps.Builder resourceType(String resourceType)
      Parameters:
      resourceType - Specifies the name of the resource type that this customer managed permission applies to. This parameter is required. The format is *<service-code>* : *<resource-type>* and is not case sensitive. For example, to specify an Amazon EC2 Subnet, you can use the string ec2:subnet . To see the list of valid values for this parameter, query the ListResourceTypes operation.
      Returns:
      this
    • tags

      @Stability(Stable) public CfnPermissionProps.Builder tags(List<? extends CfnTag> tags)
      Parameters:
      tags - Specifies a list of one or more tag key and value pairs to attach to the permission.
      Returns:
      this
    • build

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