Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. connect
  5. SecurityProfile
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.connect.SecurityProfile

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Provides an Amazon Connect Security Profile resource. For more information see Amazon Connect: Getting Started

Example Usage

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

const example = new aws.connect.SecurityProfile("example", {
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name: "example",
    description: "example description",
    permissions: [
        "BasicAgentAccess",
        "OutboundCallAccess",
    ],
    tags: {
        Name: "Example Security Profile",
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.connect.SecurityProfile("example",
    instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name="example",
    description="example description",
    permissions=[
        "BasicAgentAccess",
        "OutboundCallAccess",
    ],
    tags={
        "Name": "Example Security Profile",
    })
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewSecurityProfile(ctx, "example", &connect.SecurityProfileArgs{
			InstanceId:  pulumi.String("aaaaaaaa-bbbb-cccc-dddd-111111111111"),
			Name:        pulumi.String("example"),
			Description: pulumi.String("example description"),
			Permissions: pulumi.StringArray{
				pulumi.String("BasicAgentAccess"),
				pulumi.String("OutboundCallAccess"),
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Example Security Profile"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Connect.SecurityProfile("example", new()
    {
        InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        Name = "example",
        Description = "example description",
        Permissions = new[]
        {
            "BasicAgentAccess",
            "OutboundCallAccess",
        },
        Tags = 
        {
            { "Name", "Example Security Profile" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.SecurityProfile;
import com.pulumi.aws.connect.SecurityProfileArgs;
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 SecurityProfile("example", SecurityProfileArgs.builder()
            .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
            .name("example")
            .description("example description")
            .permissions(            
                "BasicAgentAccess",
                "OutboundCallAccess")
            .tags(Map.of("Name", "Example Security Profile"))
            .build());

    }
}
Copy
resources:
  example:
    type: aws:connect:SecurityProfile
    properties:
      instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
      name: example
      description: example description
      permissions:
        - BasicAgentAccess
        - OutboundCallAccess
      tags:
        Name: Example Security Profile
Copy

Create SecurityProfile Resource

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

Constructor syntax

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

@overload
def SecurityProfile(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    instance_id: Optional[str] = None,
                    description: Optional[str] = None,
                    name: Optional[str] = None,
                    permissions: Optional[Sequence[str]] = None,
                    tags: Optional[Mapping[str, str]] = None)
func NewSecurityProfile(ctx *Context, name string, args SecurityProfileArgs, opts ...ResourceOption) (*SecurityProfile, error)
public SecurityProfile(string name, SecurityProfileArgs args, CustomResourceOptions? opts = null)
public SecurityProfile(String name, SecurityProfileArgs args)
public SecurityProfile(String name, SecurityProfileArgs args, CustomResourceOptions options)

type: aws:connect:SecurityProfile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SecurityProfileArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SecurityProfileArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SecurityProfileArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SecurityProfileArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SecurityProfileArgs
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 securityProfileResource = new Aws.Connect.SecurityProfile("securityProfileResource", new()
{
    InstanceId = "string",
    Description = "string",
    Name = "string",
    Permissions = new[]
    {
        "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := connect.NewSecurityProfile(ctx, "securityProfileResource", &connect.SecurityProfileArgs{
	InstanceId:  pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Permissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var securityProfileResource = new SecurityProfile("securityProfileResource", SecurityProfileArgs.builder()
    .instanceId("string")
    .description("string")
    .name("string")
    .permissions("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
security_profile_resource = aws.connect.SecurityProfile("securityProfileResource",
    instance_id="string",
    description="string",
    name="string",
    permissions=["string"],
    tags={
        "string": "string",
    })
Copy
const securityProfileResource = new aws.connect.SecurityProfile("securityProfileResource", {
    instanceId: "string",
    description: "string",
    name: "string",
    permissions: ["string"],
    tags: {
        string: "string",
    },
});
Copy
type: aws:connect:SecurityProfile
properties:
    description: string
    instanceId: string
    name: string
    permissions:
        - string
    tags:
        string: string
Copy

SecurityProfile Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SecurityProfile resource accepts the following input properties:

InstanceId This property is required. string
Specifies the identifier of the hosting Amazon Connect Instance.
Description string
Specifies the description of the Security Profile.
Name Changes to this property will trigger replacement. string
Specifies the name of the Security Profile.
Permissions List<string>
Specifies a list of permissions assigned to the security profile.
Tags Dictionary<string, string>
Tags to apply to the Security Profile. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
InstanceId This property is required. string
Specifies the identifier of the hosting Amazon Connect Instance.
Description string
Specifies the description of the Security Profile.
Name Changes to this property will trigger replacement. string
Specifies the name of the Security Profile.
Permissions []string
Specifies a list of permissions assigned to the security profile.
Tags map[string]string
Tags to apply to the Security Profile. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
instanceId This property is required. String
Specifies the identifier of the hosting Amazon Connect Instance.
description String
Specifies the description of the Security Profile.
name Changes to this property will trigger replacement. String
Specifies the name of the Security Profile.
permissions List<String>
Specifies a list of permissions assigned to the security profile.
tags Map<String,String>
Tags to apply to the Security Profile. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
instanceId This property is required. string
Specifies the identifier of the hosting Amazon Connect Instance.
description string
Specifies the description of the Security Profile.
name Changes to this property will trigger replacement. string
Specifies the name of the Security Profile.
permissions string[]
Specifies a list of permissions assigned to the security profile.
tags {[key: string]: string}
Tags to apply to the Security Profile. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
instance_id This property is required. str
Specifies the identifier of the hosting Amazon Connect Instance.
description str
Specifies the description of the Security Profile.
name Changes to this property will trigger replacement. str
Specifies the name of the Security Profile.
permissions Sequence[str]
Specifies a list of permissions assigned to the security profile.
tags Mapping[str, str]
Tags to apply to the Security Profile. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
instanceId This property is required. String
Specifies the identifier of the hosting Amazon Connect Instance.
description String
Specifies the description of the Security Profile.
name Changes to this property will trigger replacement. String
Specifies the name of the Security Profile.
permissions List<String>
Specifies a list of permissions assigned to the security profile.
tags Map<String>
Tags to apply to the Security Profile. 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 SecurityProfile resource produces the following output properties:

Arn string
The Amazon Resource Name (ARN) of the Security Profile.
Id string
The provider-assigned unique ID for this managed resource.
OrganizationResourceId string
The organization resource identifier for the security profile.
SecurityProfileId string
The identifier for the Security Profile.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
The Amazon Resource Name (ARN) of the Security Profile.
Id string
The provider-assigned unique ID for this managed resource.
OrganizationResourceId string
The organization resource identifier for the security profile.
SecurityProfileId string
The identifier for the Security Profile.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The Amazon Resource Name (ARN) of the Security Profile.
id String
The provider-assigned unique ID for this managed resource.
organizationResourceId String
The organization resource identifier for the security profile.
securityProfileId String
The identifier for the Security Profile.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
The Amazon Resource Name (ARN) of the Security Profile.
id string
The provider-assigned unique ID for this managed resource.
organizationResourceId string
The organization resource identifier for the security profile.
securityProfileId string
The identifier for the Security Profile.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
The Amazon Resource Name (ARN) of the Security Profile.
id str
The provider-assigned unique ID for this managed resource.
organization_resource_id str
The organization resource identifier for the security profile.
security_profile_id str
The identifier for the Security Profile.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The Amazon Resource Name (ARN) of the Security Profile.
id String
The provider-assigned unique ID for this managed resource.
organizationResourceId String
The organization resource identifier for the security profile.
securityProfileId String
The identifier for the Security Profile.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing SecurityProfile Resource

Get an existing SecurityProfile 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?: SecurityProfileState, opts?: CustomResourceOptions): SecurityProfile
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        instance_id: Optional[str] = None,
        name: Optional[str] = None,
        organization_resource_id: Optional[str] = None,
        permissions: Optional[Sequence[str]] = None,
        security_profile_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> SecurityProfile
func GetSecurityProfile(ctx *Context, name string, id IDInput, state *SecurityProfileState, opts ...ResourceOption) (*SecurityProfile, error)
public static SecurityProfile Get(string name, Input<string> id, SecurityProfileState? state, CustomResourceOptions? opts = null)
public static SecurityProfile get(String name, Output<String> id, SecurityProfileState state, CustomResourceOptions options)
resources:  _:    type: aws:connect:SecurityProfile    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Arn string
The Amazon Resource Name (ARN) of the Security Profile.
Description string
Specifies the description of the Security Profile.
InstanceId string
Specifies the identifier of the hosting Amazon Connect Instance.
Name Changes to this property will trigger replacement. string
Specifies the name of the Security Profile.
OrganizationResourceId string
The organization resource identifier for the security profile.
Permissions List<string>
Specifies a list of permissions assigned to the security profile.
SecurityProfileId string
The identifier for the Security Profile.
Tags Dictionary<string, string>
Tags to apply to the Security Profile. 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>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
The Amazon Resource Name (ARN) of the Security Profile.
Description string
Specifies the description of the Security Profile.
InstanceId string
Specifies the identifier of the hosting Amazon Connect Instance.
Name Changes to this property will trigger replacement. string
Specifies the name of the Security Profile.
OrganizationResourceId string
The organization resource identifier for the security profile.
Permissions []string
Specifies a list of permissions assigned to the security profile.
SecurityProfileId string
The identifier for the Security Profile.
Tags map[string]string
Tags to apply to the Security Profile. 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
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The Amazon Resource Name (ARN) of the Security Profile.
description String
Specifies the description of the Security Profile.
instanceId String
Specifies the identifier of the hosting Amazon Connect Instance.
name Changes to this property will trigger replacement. String
Specifies the name of the Security Profile.
organizationResourceId String
The organization resource identifier for the security profile.
permissions List<String>
Specifies a list of permissions assigned to the security profile.
securityProfileId String
The identifier for the Security Profile.
tags Map<String,String>
Tags to apply to the Security Profile. 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>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
The Amazon Resource Name (ARN) of the Security Profile.
description string
Specifies the description of the Security Profile.
instanceId string
Specifies the identifier of the hosting Amazon Connect Instance.
name Changes to this property will trigger replacement. string
Specifies the name of the Security Profile.
organizationResourceId string
The organization resource identifier for the security profile.
permissions string[]
Specifies a list of permissions assigned to the security profile.
securityProfileId string
The identifier for the Security Profile.
tags {[key: string]: string}
Tags to apply to the Security Profile. 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}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
The Amazon Resource Name (ARN) of the Security Profile.
description str
Specifies the description of the Security Profile.
instance_id str
Specifies the identifier of the hosting Amazon Connect Instance.
name Changes to this property will trigger replacement. str
Specifies the name of the Security Profile.
organization_resource_id str
The organization resource identifier for the security profile.
permissions Sequence[str]
Specifies a list of permissions assigned to the security profile.
security_profile_id str
The identifier for the Security Profile.
tags Mapping[str, str]
Tags to apply to the Security Profile. 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]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The Amazon Resource Name (ARN) of the Security Profile.
description String
Specifies the description of the Security Profile.
instanceId String
Specifies the identifier of the hosting Amazon Connect Instance.
name Changes to this property will trigger replacement. String
Specifies the name of the Security Profile.
organizationResourceId String
The organization resource identifier for the security profile.
permissions List<String>
Specifies a list of permissions assigned to the security profile.
securityProfileId String
The identifier for the Security Profile.
tags Map<String>
Tags to apply to the Security Profile. 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>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Import

Using pulumi import, import Amazon Connect Security Profiles using the instance_id and security_profile_id separated by a colon (:). For example:

$ pulumi import aws:connect/securityProfile:SecurityProfile example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws