1. Packages
  2. AWS Native
  3. API Docs
  4. opensearchserverless
  5. AccessPolicy

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

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

aws-native.opensearchserverless.AccessPolicy

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

    Amazon OpenSearchServerless access policy resource

    Create AccessPolicy Resource

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

    Constructor syntax

    new AccessPolicy(name: string, args: AccessPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def AccessPolicy(resource_name: str,
                     args: AccessPolicyArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def AccessPolicy(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     policy: Optional[str] = None,
                     type: Optional[AccessPolicyType] = None,
                     description: Optional[str] = None,
                     name: Optional[str] = None)
    func NewAccessPolicy(ctx *Context, name string, args AccessPolicyArgs, opts ...ResourceOption) (*AccessPolicy, error)
    public AccessPolicy(string name, AccessPolicyArgs args, CustomResourceOptions? opts = null)
    public AccessPolicy(String name, AccessPolicyArgs args)
    public AccessPolicy(String name, AccessPolicyArgs args, CustomResourceOptions options)
    
    type: aws-native:opensearchserverless:AccessPolicy
    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 AccessPolicyArgs
    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 AccessPolicyArgs
    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 AccessPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccessPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccessPolicyArgs
    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 aws_nativeAccessPolicyResource = new aws_native.opensearchserverless.AccessPolicy("aws-nativeAccessPolicyResource", {
        policy: "string",
        type: aws_native.opensearchserverless.AccessPolicyType.Data,
        description: "string",
        name: "string",
    });
    
    Coming soon!
    

    AccessPolicy 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 AccessPolicy resource accepts the following input properties:

    Policy string
    The JSON policy document that is the content for the policy
    Type Pulumi.AwsNative.OpenSearchServerless.AccessPolicyType
    Description string
    The description of the policy
    Name string
    The name of the policy
    Policy string
    The JSON policy document that is the content for the policy
    Type AccessPolicyType
    Description string
    The description of the policy
    Name string
    The name of the policy
    policy String
    The JSON policy document that is the content for the policy
    type AccessPolicyType
    description String
    The description of the policy
    name String
    The name of the policy
    policy string
    The JSON policy document that is the content for the policy
    type AccessPolicyType
    description string
    The description of the policy
    name string
    The name of the policy
    policy str
    The JSON policy document that is the content for the policy
    type AccessPolicyType
    description str
    The description of the policy
    name str
    The name of the policy
    policy String
    The JSON policy document that is the content for the policy
    type "data"
    description String
    The description of the policy
    name String
    The name of the policy

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    AccessPolicyType, AccessPolicyTypeArgs

    Data
    data
    AccessPolicyTypeData
    data
    Data
    data
    Data
    data
    DATA
    data
    "data"
    data

    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.103.0 published on Monday, Apr 22, 2024 by Pulumi