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

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

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

aws-native.iotsitewise.AccessPolicy

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi

    Resource schema for AWS::IoTSiteWise::AccessPolicy

    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,
                     access_policy_identity: Optional[AccessPolicyIdentityArgs] = None,
                     access_policy_permission: Optional[str] = None,
                     access_policy_resource: Optional[AccessPolicyResourceArgs] = 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:iotsitewise: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 accessPolicyResource = new aws_native.iotsitewise.AccessPolicy("accessPolicyResource", {
        accessPolicyIdentity: {
            iamRole: {
                arn: "string",
            },
            iamUser: {
                arn: "string",
            },
            user: {
                id: "string",
            },
        },
        accessPolicyPermission: "string",
        accessPolicyResource: {
            portal: {
                id: "string",
            },
            project: {
                id: "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:

    AccessPolicyIdentity Pulumi.AwsNative.IoTSiteWise.Inputs.AccessPolicyIdentity
    The identity for this access policy. Choose either a user or a group but not both.
    AccessPolicyPermission string
    The permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER.
    AccessPolicyResource Pulumi.AwsNative.IoTSiteWise.Inputs.AccessPolicyResource
    The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.
    AccessPolicyIdentity AccessPolicyIdentityArgs
    The identity for this access policy. Choose either a user or a group but not both.
    AccessPolicyPermission string
    The permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER.
    AccessPolicyResource AccessPolicyResourceArgs
    The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.
    accessPolicyIdentity AccessPolicyIdentity
    The identity for this access policy. Choose either a user or a group but not both.
    accessPolicyPermission String
    The permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER.
    accessPolicyResource AccessPolicyResource
    The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.
    accessPolicyIdentity AccessPolicyIdentity
    The identity for this access policy. Choose either a user or a group but not both.
    accessPolicyPermission string
    The permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER.
    accessPolicyResource AccessPolicyResource
    The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.
    access_policy_identity AccessPolicyIdentityArgs
    The identity for this access policy. Choose either a user or a group but not both.
    access_policy_permission str
    The permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER.
    access_policy_resource AccessPolicyResourceArgs
    The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.
    accessPolicyIdentity Property Map
    The identity for this access policy. Choose either a user or a group but not both.
    accessPolicyPermission String
    The permission level for this access policy. Valid values are ADMINISTRATOR or VIEWER.
    accessPolicyResource Property Map
    The AWS IoT SiteWise Monitor resource for this access policy. Choose either portal or project but not both.

    Outputs

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

    AccessPolicyArn string
    The ARN of the access policy.
    AccessPolicyId string
    The ID of the access policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    AccessPolicyArn string
    The ARN of the access policy.
    AccessPolicyId string
    The ID of the access policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    accessPolicyArn String
    The ARN of the access policy.
    accessPolicyId String
    The ID of the access policy.
    id String
    The provider-assigned unique ID for this managed resource.
    accessPolicyArn string
    The ARN of the access policy.
    accessPolicyId string
    The ID of the access policy.
    id string
    The provider-assigned unique ID for this managed resource.
    access_policy_arn str
    The ARN of the access policy.
    access_policy_id str
    The ID of the access policy.
    id str
    The provider-assigned unique ID for this managed resource.
    accessPolicyArn String
    The ARN of the access policy.
    accessPolicyId String
    The ID of the access policy.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    AccessPolicyIamRole, AccessPolicyIamRoleArgs

    Arn string
    The ARN of the IAM role.
    Arn string
    The ARN of the IAM role.
    arn String
    The ARN of the IAM role.
    arn string
    The ARN of the IAM role.
    arn str
    The ARN of the IAM role.
    arn String
    The ARN of the IAM role.

    AccessPolicyIamUser, AccessPolicyIamUserArgs

    Arn string
    The ARN of the IAM user.
    Arn string
    The ARN of the IAM user.
    arn String
    The ARN of the IAM user.
    arn string
    The ARN of the IAM user.
    arn str
    The ARN of the IAM user.
    arn String
    The ARN of the IAM user.

    AccessPolicyIdentity, AccessPolicyIdentityArgs

    AccessPolicyPortal, AccessPolicyPortalArgs

    Id string
    The ID of the portal.
    Id string
    The ID of the portal.
    id String
    The ID of the portal.
    id string
    The ID of the portal.
    id str
    The ID of the portal.
    id String
    The ID of the portal.

    AccessPolicyProject, AccessPolicyProjectArgs

    Id string
    The ID of the project.
    Id string
    The ID of the project.
    id String
    The ID of the project.
    id string
    The ID of the project.
    id str
    The ID of the project.
    id String
    The ID of the project.

    AccessPolicyResource, AccessPolicyResourceArgs

    AccessPolicyUser, AccessPolicyUserArgs

    Id string
    The AWS SSO ID of the user.
    Id string
    The AWS SSO ID of the user.
    id String
    The AWS SSO ID of the user.
    id string
    The AWS SSO ID of the user.
    id str
    The AWS SSO ID of the user.
    id String
    The AWS SSO ID of the user.

    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.102.0 published on Tuesday, Apr 16, 2024 by Pulumi