1. Packages
  2. AWS Native
  3. API Docs
  4. vpclattice
  5. AuthPolicy

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.vpclattice.AuthPolicy

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    Creates or updates the auth policy.

    Create AuthPolicy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AuthPolicy(name: string, args: AuthPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def AuthPolicy(resource_name: str,
                   args: AuthPolicyArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def AuthPolicy(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   policy: Optional[Any] = None,
                   resource_identifier: Optional[str] = None)
    func NewAuthPolicy(ctx *Context, name string, args AuthPolicyArgs, opts ...ResourceOption) (*AuthPolicy, error)
    public AuthPolicy(string name, AuthPolicyArgs args, CustomResourceOptions? opts = null)
    public AuthPolicy(String name, AuthPolicyArgs args)
    public AuthPolicy(String name, AuthPolicyArgs args, CustomResourceOptions options)
    
    type: aws-native:vpclattice:AuthPolicy
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AuthPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AuthPolicyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AuthPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const authPolicyResource = new aws_native.vpclattice.AuthPolicy("authPolicyResource", {
        policy: "any",
        resourceIdentifier: "string",
    });
    
    Coming soon!
    

    AuthPolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AuthPolicy resource accepts the following input properties:

    Policy object

    The auth policy.

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

    ResourceIdentifier string
    The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created.
    Policy interface{}

    The auth policy.

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

    ResourceIdentifier string
    The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created.
    policy Object

    The auth policy.

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

    resourceIdentifier String
    The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created.
    policy any

    The auth policy.

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

    resourceIdentifier string
    The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created.
    policy Any

    The auth policy.

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

    resource_identifier str
    The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created.
    policy Any

    The auth policy.

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

    resourceIdentifier String
    The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AuthPolicy resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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, AuthPolicyStateArgs

    Active
    ACTIVE
    Inactive
    INACTIVE
    AuthPolicyStateActive
    ACTIVE
    AuthPolicyStateInactive
    INACTIVE
    Active
    ACTIVE
    Inactive
    INACTIVE
    Active
    ACTIVE
    Inactive
    INACTIVE
    ACTIVE
    ACTIVE
    INACTIVE
    INACTIVE
    "ACTIVE"
    ACTIVE
    "INACTIVE"
    INACTIVE

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi