Class CfnAuthPolicy

All Implemented Interfaces:
IConstruct, IDependable, IInspectable,, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.982Z") @Stability(Stable) public class CfnAuthPolicy extends CfnResource implements IInspectable
A CloudFormation AWS::VpcLattice::AuthPolicy.

Creates or updates the auth policy. The policy string in JSON must not contain newlines or blank lines.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 Object policy;
 CfnAuthPolicy cfnAuthPolicy = CfnAuthPolicy.Builder.create(this, "MyCfnAuthPolicy")
  • Field Details


      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.
  • Constructor Details

    • CfnAuthPolicy

      protected CfnAuthPolicy( objRef)
    • CfnAuthPolicy

      protected CfnAuthPolicy( initializationMode)
    • CfnAuthPolicy

      @Stability(Stable) public CfnAuthPolicy(@NotNull Construct scope, @NotNull String id, @NotNull CfnAuthPolicyProps props)
      Create a new AWS::VpcLattice::AuthPolicy.

      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.
  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.
    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      renderProperties in class CfnResource
      props - This parameter is required.
    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The state of the auth policy.

      The auth policy is only active when the auth type is set to AWS _IAM . If you provide a policy, then authentication and authorization decisions are made based on this policy and the client's IAM policy. If the auth type is NONE , then any auth policy you provide will remain inactive.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      getCfnProperties in class CfnResource
    • getPolicy

      @Stability(Stable) @NotNull public Object getPolicy()
      The auth policy.
    • setPolicy

      @Stability(Stable) public void setPolicy(@NotNull Object value)
      The auth policy.
    • getResourceIdentifier

      @Stability(Stable) @NotNull public String getResourceIdentifier()
      The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created.
    • setResourceIdentifier

      @Stability(Stable) public void setResourceIdentifier(@NotNull String value)
      The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created.