Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. verifiedaccess
  5. Group
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.verifiedaccess.Group

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing a Verified Access Group.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.verifiedaccess.Group("example", {verifiedaccessInstanceId: exampleAwsVerifiedaccessInstance.id});

    import pulumi
import pulumi_aws as aws

example = aws.verifiedaccess.Group("example", verifiedaccess_instance_id=example_aws_verifiedaccess_instance["id"])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/verifiedaccess"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := verifiedaccess.NewGroup(ctx, "example", &verifiedaccess.GroupArgs{
			VerifiedaccessInstanceId: pulumi.Any(exampleAwsVerifiedaccessInstance.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.VerifiedAccess.Group("example", new()
    {
        VerifiedaccessInstanceId = exampleAwsVerifiedaccessInstance.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.verifiedaccess.Group;
import com.pulumi.aws.verifiedaccess.GroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Group("example", GroupArgs.builder()
            .verifiedaccessInstanceId(exampleAwsVerifiedaccessInstance.id())
            .build());

    }
}

    resources:
  example:
    type: aws:verifiedaccess:Group
    properties:
      verifiedaccessInstanceId: ${exampleAwsVerifiedaccessInstance.id}

    Usage with KMS Key

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  testKey:
    type: aws:kms:Key
    name: test_key
    properties:
      description: KMS key for Verified Access Group test
  test:
    type: aws:verifiedaccess:Group
    properties:
      verifiedaccessInstanceId: ${testAwsVerifiedaccessInstanceTrustProviderAttachment.verifiedaccessInstanceId}
      serverSideEncryptionConfiguration:
        - kmsKeyArn: ${testKey.arn}

    Create Group Resource

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

    Constructor syntax

    new Group(name: string, args: GroupArgs, opts?: CustomResourceOptions);
    @overload
def Group(resource_name: str,
          args: GroupArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          verifiedaccess_instance_id: Optional[str] = None,
          description: Optional[str] = None,
          policy_document: Optional[str] = None,
          sse_configuration: Optional[GroupSseConfigurationArgs] = None,
          tags: Optional[Mapping[str, str]] = None)
    func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
    public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
    public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

    type: aws:verifiedaccess:Group
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 GroupArgs
    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 GroupArgs
    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 GroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var examplegroupResourceResourceFromVerifiedaccessgroup = new Aws.VerifiedAccess.Group("examplegroupResourceResourceFromVerifiedaccessgroup", new()
{
    VerifiedaccessInstanceId = "string",
    Description = "string",
    PolicyDocument = "string",
    SseConfiguration = new Aws.VerifiedAccess.Inputs.GroupSseConfigurationArgs
    {
        CustomerManagedKeyEnabled = false,
        KmsKeyArn = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := verifiedaccess.NewGroup(ctx, "examplegroupResourceResourceFromVerifiedaccessgroup", &verifiedaccess.GroupArgs{
	VerifiedaccessInstanceId: pulumi.String("string"),
	Description:              pulumi.String("string"),
	PolicyDocument:           pulumi.String("string"),
	SseConfiguration: &verifiedaccess.GroupSseConfigurationArgs{
		CustomerManagedKeyEnabled: pulumi.Bool(false),
		KmsKeyArn:                 pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var examplegroupResourceResourceFromVerifiedaccessgroup = new Group("examplegroupResourceResourceFromVerifiedaccessgroup", GroupArgs.builder()
    .verifiedaccessInstanceId("string")
    .description("string")
    .policyDocument("string")
    .sseConfiguration(GroupSseConfigurationArgs.builder()
        .customerManagedKeyEnabled(false)
        .kmsKeyArn("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

    examplegroup_resource_resource_from_verifiedaccessgroup = aws.verifiedaccess.Group("examplegroupResourceResourceFromVerifiedaccessgroup",
    verifiedaccess_instance_id="string",
    description="string",
    policy_document="string",
    sse_configuration={
        "customerManagedKeyEnabled": False,
        "kmsKeyArn": "string",
    },
    tags={
        "string": "string",
    })

    const examplegroupResourceResourceFromVerifiedaccessgroup = new aws.verifiedaccess.Group("examplegroupResourceResourceFromVerifiedaccessgroup", {
    verifiedaccessInstanceId: "string",
    description: "string",
    policyDocument: "string",
    sseConfiguration: {
        customerManagedKeyEnabled: false,
        kmsKeyArn: "string",
    },
    tags: {
        string: "string",
    },
});

    type: aws:verifiedaccess:Group
properties:
    description: string
    policyDocument: string
    sseConfiguration:
        customerManagedKeyEnabled: false
        kmsKeyArn: string
    tags:
        string: string
    verifiedaccessInstanceId: string

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

    VerifiedaccessInstanceId string

    The id of the verified access instance this group is associated with.

    The following arguments are optional:

    Description string
    Description of the verified access group.
    PolicyDocument string
    The policy document that is associated with this resource.
    SseConfiguration GroupSseConfiguration
    Configuration block to use KMS keys for server-side encryption.
    Tags Dictionary<string, string>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    VerifiedaccessInstanceId string

    The id of the verified access instance this group is associated with.

    The following arguments are optional:

    Description string
    Description of the verified access group.
    PolicyDocument string
    The policy document that is associated with this resource.
    SseConfiguration GroupSseConfigurationArgs
    Configuration block to use KMS keys for server-side encryption.
    Tags map[string]string
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    verifiedaccessInstanceId String

    The id of the verified access instance this group is associated with.

    The following arguments are optional:

    description String
    Description of the verified access group.
    policyDocument String
    The policy document that is associated with this resource.
    sseConfiguration GroupSseConfiguration
    Configuration block to use KMS keys for server-side encryption.
    tags Map<String,String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    verifiedaccessInstanceId string

    The id of the verified access instance this group is associated with.

    The following arguments are optional:

    description string
    Description of the verified access group.
    policyDocument string
    The policy document that is associated with this resource.
    sseConfiguration GroupSseConfiguration
    Configuration block to use KMS keys for server-side encryption.
    tags {[key: string]: string}
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    verifiedaccess_instance_id str

    The id of the verified access instance this group is associated with.

    The following arguments are optional:

    description str
    Description of the verified access group.
    policy_document str
    The policy document that is associated with this resource.
    sse_configuration GroupSseConfigurationArgs
    Configuration block to use KMS keys for server-side encryption.
    tags Mapping[str, str]
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    verifiedaccessInstanceId String

    The id of the verified access instance this group is associated with.

    The following arguments are optional:

    description String
    Description of the verified access group.
    policyDocument String
    The policy document that is associated with this resource.
    sseConfiguration Property Map
    Configuration block to use KMS keys for server-side encryption.
    tags Map<String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    CreationTime string
    Timestamp when the access group was created.
    DeletionTime string
    Timestamp when the access group was deleted.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedTime string
    Timestamp when the access group was last updated.
    Owner string
    AWS account number owning this resource.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    VerifiedaccessGroupArn string
    ARN of this verified acess group.
    VerifiedaccessGroupId string
    ID of this verified access group.
    CreationTime string
    Timestamp when the access group was created.
    DeletionTime string
    Timestamp when the access group was deleted.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedTime string
    Timestamp when the access group was last updated.
    Owner string
    AWS account number owning this resource.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    VerifiedaccessGroupArn string
    ARN of this verified acess group.
    VerifiedaccessGroupId string
    ID of this verified access group.
    creationTime String
    Timestamp when the access group was created.
    deletionTime String
    Timestamp when the access group was deleted.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime String
    Timestamp when the access group was last updated.
    owner String
    AWS account number owning this resource.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    verifiedaccessGroupArn String
    ARN of this verified acess group.
    verifiedaccessGroupId String
    ID of this verified access group.
    creationTime string
    Timestamp when the access group was created.
    deletionTime string
    Timestamp when the access group was deleted.
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime string
    Timestamp when the access group was last updated.
    owner string
    AWS account number owning this resource.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    verifiedaccessGroupArn string
    ARN of this verified acess group.
    verifiedaccessGroupId string
    ID of this verified access group.
    creation_time str
    Timestamp when the access group was created.
    deletion_time str
    Timestamp when the access group was deleted.
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated_time str
    Timestamp when the access group was last updated.
    owner str
    AWS account number owning this resource.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    verifiedaccess_group_arn str
    ARN of this verified acess group.
    verifiedaccess_group_id str
    ID of this verified access group.
    creationTime String
    Timestamp when the access group was created.
    deletionTime String
    Timestamp when the access group was deleted.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime String
    Timestamp when the access group was last updated.
    owner String
    AWS account number owning this resource.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    verifiedaccessGroupArn String
    ARN of this verified acess group.
    verifiedaccessGroupId String
    ID of this verified access group.

    Look up Existing Group Resource

    Get an existing Group resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GroupState, opts?: CustomResourceOptions): Group
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        creation_time: Optional[str] = None,
        deletion_time: Optional[str] = None,
        description: Optional[str] = None,
        last_updated_time: Optional[str] = None,
        owner: Optional[str] = None,
        policy_document: Optional[str] = None,
        sse_configuration: Optional[GroupSseConfigurationArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        verifiedaccess_group_arn: Optional[str] = None,
        verifiedaccess_group_id: Optional[str] = None,
        verifiedaccess_instance_id: Optional[str] = None) -> Group
    func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
    public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
    public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreationTime string
    Timestamp when the access group was created.
    DeletionTime string
    Timestamp when the access group was deleted.
    Description string
    Description of the verified access group.
    LastUpdatedTime string
    Timestamp when the access group was last updated.
    Owner string
    AWS account number owning this resource.
    PolicyDocument string
    The policy document that is associated with this resource.
    SseConfiguration GroupSseConfiguration
    Configuration block to use KMS keys for server-side encryption.
    Tags Dictionary<string, string>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    VerifiedaccessGroupArn string
    ARN of this verified acess group.
    VerifiedaccessGroupId string
    ID of this verified access group.
    VerifiedaccessInstanceId string

    The id of the verified access instance this group is associated with.

    The following arguments are optional:

    CreationTime string
    Timestamp when the access group was created.
    DeletionTime string
    Timestamp when the access group was deleted.
    Description string
    Description of the verified access group.
    LastUpdatedTime string
    Timestamp when the access group was last updated.
    Owner string
    AWS account number owning this resource.
    PolicyDocument string
    The policy document that is associated with this resource.
    SseConfiguration GroupSseConfigurationArgs
    Configuration block to use KMS keys for server-side encryption.
    Tags map[string]string
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    VerifiedaccessGroupArn string
    ARN of this verified acess group.
    VerifiedaccessGroupId string
    ID of this verified access group.
    VerifiedaccessInstanceId string

    The id of the verified access instance this group is associated with.

    The following arguments are optional:

    creationTime String
    Timestamp when the access group was created.
    deletionTime String
    Timestamp when the access group was deleted.
    description String
    Description of the verified access group.
    lastUpdatedTime String
    Timestamp when the access group was last updated.
    owner String
    AWS account number owning this resource.
    policyDocument String
    The policy document that is associated with this resource.
    sseConfiguration GroupSseConfiguration
    Configuration block to use KMS keys for server-side encryption.
    tags Map<String,String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    verifiedaccessGroupArn String
    ARN of this verified acess group.
    verifiedaccessGroupId String
    ID of this verified access group.
    verifiedaccessInstanceId String

    The id of the verified access instance this group is associated with.

    The following arguments are optional:

    creationTime string
    Timestamp when the access group was created.
    deletionTime string
    Timestamp when the access group was deleted.
    description string
    Description of the verified access group.
    lastUpdatedTime string
    Timestamp when the access group was last updated.
    owner string
    AWS account number owning this resource.
    policyDocument string
    The policy document that is associated with this resource.
    sseConfiguration GroupSseConfiguration
    Configuration block to use KMS keys for server-side encryption.
    tags {[key: string]: string}
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    verifiedaccessGroupArn string
    ARN of this verified acess group.
    verifiedaccessGroupId string
    ID of this verified access group.
    verifiedaccessInstanceId string

    The id of the verified access instance this group is associated with.

    The following arguments are optional:

    creation_time str
    Timestamp when the access group was created.
    deletion_time str
    Timestamp when the access group was deleted.
    description str
    Description of the verified access group.
    last_updated_time str
    Timestamp when the access group was last updated.
    owner str
    AWS account number owning this resource.
    policy_document str
    The policy document that is associated with this resource.
    sse_configuration GroupSseConfigurationArgs
    Configuration block to use KMS keys for server-side encryption.
    tags Mapping[str, str]
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    verifiedaccess_group_arn str
    ARN of this verified acess group.
    verifiedaccess_group_id str
    ID of this verified access group.
    verifiedaccess_instance_id str

    The id of the verified access instance this group is associated with.

    The following arguments are optional:

    creationTime String
    Timestamp when the access group was created.
    deletionTime String
    Timestamp when the access group was deleted.
    description String
    Description of the verified access group.
    lastUpdatedTime String
    Timestamp when the access group was last updated.
    owner String
    AWS account number owning this resource.
    policyDocument String
    The policy document that is associated with this resource.
    sseConfiguration Property Map
    Configuration block to use KMS keys for server-side encryption.
    tags Map<String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    verifiedaccessGroupArn String
    ARN of this verified acess group.
    verifiedaccessGroupId String
    ID of this verified access group.
    verifiedaccessInstanceId String

    The id of the verified access instance this group is associated with.

    The following arguments are optional:

    Supporting Types

    GroupSseConfiguration, GroupSseConfigurationArgs

    CustomerManagedKeyEnabled bool
    KmsKeyArn string
    ARN of the KMS key to use.
    CustomerManagedKeyEnabled bool
    KmsKeyArn string
    ARN of the KMS key to use.
    customerManagedKeyEnabled Boolean
    kmsKeyArn String
    ARN of the KMS key to use.
    customerManagedKeyEnabled boolean
    kmsKeyArn string
    ARN of the KMS key to use.
    customer_managed_key_enabled bool
    kms_key_arn str
    ARN of the KMS key to use.
    customerManagedKeyEnabled Boolean
    kmsKeyArn String
    ARN of the KMS key to use.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws