1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. vpclattice
  5. getAuthPolicy

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.15.0 published on Wednesday, Dec 11, 2024 by Pulumi

aws-native.vpclattice.getAuthPolicy

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.15.0 published on Wednesday, Dec 11, 2024 by Pulumi

    Creates or updates the auth policy.

    Using getAuthPolicy

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAuthPolicy(args: GetAuthPolicyArgs, opts?: InvokeOptions): Promise<GetAuthPolicyResult>
    function getAuthPolicyOutput(args: GetAuthPolicyOutputArgs, opts?: InvokeOptions): Output<GetAuthPolicyResult>
    def get_auth_policy(resource_identifier: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetAuthPolicyResult
    def get_auth_policy_output(resource_identifier: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetAuthPolicyResult]
    func LookupAuthPolicy(ctx *Context, args *LookupAuthPolicyArgs, opts ...InvokeOption) (*LookupAuthPolicyResult, error)
    func LookupAuthPolicyOutput(ctx *Context, args *LookupAuthPolicyOutputArgs, opts ...InvokeOption) LookupAuthPolicyResultOutput

    > Note: This function is named LookupAuthPolicy in the Go SDK.

    public static class GetAuthPolicy 
    {
        public static Task<GetAuthPolicyResult> InvokeAsync(GetAuthPolicyArgs args, InvokeOptions? opts = null)
        public static Output<GetAuthPolicyResult> Invoke(GetAuthPolicyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAuthPolicyResult> getAuthPolicy(GetAuthPolicyArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:vpclattice:getAuthPolicy
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ResourceIdentifier string
    The ID or ARN of the service network or service for which the policy is created.
    ResourceIdentifier string
    The ID or ARN of the service network or service for which the policy is created.
    resourceIdentifier String
    The ID or ARN of the service network or service for which the policy is created.
    resourceIdentifier string
    The ID or ARN of the service network or service for which the policy is created.
    resource_identifier str
    The ID or ARN of the service network or service for which the policy is created.
    resourceIdentifier String
    The ID or ARN of the service network or service for which the policy is created.

    getAuthPolicy Result

    The following output properties are available:

    Policy object

    The auth policy.

    Search the CloudFormation User Guide for AWS::VpcLattice::AuthPolicy for more information about the expected schema for this property.

    State Pulumi.AwsNative.VpcLattice.AuthPolicyState
    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.
    Policy interface{}

    The auth policy.

    Search the CloudFormation User Guide for AWS::VpcLattice::AuthPolicy for more information about the expected schema for this property.

    State AuthPolicyStateEnum
    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.
    policy Object

    The auth policy.

    Search the CloudFormation User Guide for AWS::VpcLattice::AuthPolicy for more information about the expected schema for this property.

    state AuthPolicyState
    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.
    policy any

    The auth policy.

    Search the CloudFormation User Guide for AWS::VpcLattice::AuthPolicy for more information about the expected schema for this property.

    state AuthPolicyState
    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.
    policy Any

    The auth policy.

    Search the CloudFormation User Guide for AWS::VpcLattice::AuthPolicy for more information about the expected schema for this property.

    state AuthPolicyState
    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.
    policy Any

    The auth policy.

    Search the CloudFormation User Guide for AWS::VpcLattice::AuthPolicy for more information about the expected schema for this property.

    state "ACTIVE" | "INACTIVE"
    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.

    Supporting Types

    AuthPolicyState

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.15.0 published on Wednesday, Dec 11, 2024 by Pulumi