github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/connect/getSecurityProfile.go (about)

     1  // Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
     2  // *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
     3  
     4  package connect
     5  
     6  import (
     7  	"context"
     8  	"reflect"
     9  
    10  	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
    11  	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    12  )
    13  
    14  // Provides details about a specific Amazon Connect Security Profile.
    15  //
    16  // ## Example Usage
    17  //
    18  // By `name`
    19  //
    20  // <!--Start PulumiCodeChooser -->
    21  // ```go
    22  // package main
    23  //
    24  // import (
    25  //
    26  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
    27  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    28  //
    29  // )
    30  //
    31  //	func main() {
    32  //		pulumi.Run(func(ctx *pulumi.Context) error {
    33  //			_, err := connect.LookupSecurityProfile(ctx, &connect.LookupSecurityProfileArgs{
    34  //				InstanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    35  //				Name:       pulumi.StringRef("Example"),
    36  //			}, nil)
    37  //			if err != nil {
    38  //				return err
    39  //			}
    40  //			return nil
    41  //		})
    42  //	}
    43  //
    44  // ```
    45  // <!--End PulumiCodeChooser -->
    46  //
    47  // By `securityProfileId`
    48  //
    49  // <!--Start PulumiCodeChooser -->
    50  // ```go
    51  // package main
    52  //
    53  // import (
    54  //
    55  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
    56  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    57  //
    58  // )
    59  //
    60  //	func main() {
    61  //		pulumi.Run(func(ctx *pulumi.Context) error {
    62  //			_, err := connect.LookupSecurityProfile(ctx, &connect.LookupSecurityProfileArgs{
    63  //				InstanceId:        "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    64  //				SecurityProfileId: pulumi.StringRef("cccccccc-bbbb-cccc-dddd-111111111111"),
    65  //			}, nil)
    66  //			if err != nil {
    67  //				return err
    68  //			}
    69  //			return nil
    70  //		})
    71  //	}
    72  //
    73  // ```
    74  // <!--End PulumiCodeChooser -->
    75  func LookupSecurityProfile(ctx *pulumi.Context, args *LookupSecurityProfileArgs, opts ...pulumi.InvokeOption) (*LookupSecurityProfileResult, error) {
    76  	opts = internal.PkgInvokeDefaultOpts(opts)
    77  	var rv LookupSecurityProfileResult
    78  	err := ctx.Invoke("aws:connect/getSecurityProfile:getSecurityProfile", args, &rv, opts...)
    79  	if err != nil {
    80  		return nil, err
    81  	}
    82  	return &rv, nil
    83  }
    84  
    85  // A collection of arguments for invoking getSecurityProfile.
    86  type LookupSecurityProfileArgs struct {
    87  	// Reference to the hosting Amazon Connect Instance
    88  	InstanceId string `pulumi:"instanceId"`
    89  	// Returns information on a specific Security Profile by name
    90  	Name *string `pulumi:"name"`
    91  	// Returns information on a specific Security Profile by Security Profile id
    92  	SecurityProfileId *string `pulumi:"securityProfileId"`
    93  	// Map of tags to assign to the Security Profile.
    94  	Tags map[string]string `pulumi:"tags"`
    95  }
    96  
    97  // A collection of values returned by getSecurityProfile.
    98  type LookupSecurityProfileResult struct {
    99  	// ARN of the Security Profile.
   100  	Arn string `pulumi:"arn"`
   101  	// Description of the Security Profile.
   102  	Description string `pulumi:"description"`
   103  	// The provider-assigned unique ID for this managed resource.
   104  	Id         string `pulumi:"id"`
   105  	InstanceId string `pulumi:"instanceId"`
   106  	Name       string `pulumi:"name"`
   107  	// The organization resource identifier for the security profile.
   108  	OrganizationResourceId string `pulumi:"organizationResourceId"`
   109  	// List of permissions assigned to the security profile.
   110  	Permissions       []string `pulumi:"permissions"`
   111  	SecurityProfileId string   `pulumi:"securityProfileId"`
   112  	// Map of tags to assign to the Security Profile.
   113  	Tags map[string]string `pulumi:"tags"`
   114  }
   115  
   116  func LookupSecurityProfileOutput(ctx *pulumi.Context, args LookupSecurityProfileOutputArgs, opts ...pulumi.InvokeOption) LookupSecurityProfileResultOutput {
   117  	return pulumi.ToOutputWithContext(context.Background(), args).
   118  		ApplyT(func(v interface{}) (LookupSecurityProfileResult, error) {
   119  			args := v.(LookupSecurityProfileArgs)
   120  			r, err := LookupSecurityProfile(ctx, &args, opts...)
   121  			var s LookupSecurityProfileResult
   122  			if r != nil {
   123  				s = *r
   124  			}
   125  			return s, err
   126  		}).(LookupSecurityProfileResultOutput)
   127  }
   128  
   129  // A collection of arguments for invoking getSecurityProfile.
   130  type LookupSecurityProfileOutputArgs struct {
   131  	// Reference to the hosting Amazon Connect Instance
   132  	InstanceId pulumi.StringInput `pulumi:"instanceId"`
   133  	// Returns information on a specific Security Profile by name
   134  	Name pulumi.StringPtrInput `pulumi:"name"`
   135  	// Returns information on a specific Security Profile by Security Profile id
   136  	SecurityProfileId pulumi.StringPtrInput `pulumi:"securityProfileId"`
   137  	// Map of tags to assign to the Security Profile.
   138  	Tags pulumi.StringMapInput `pulumi:"tags"`
   139  }
   140  
   141  func (LookupSecurityProfileOutputArgs) ElementType() reflect.Type {
   142  	return reflect.TypeOf((*LookupSecurityProfileArgs)(nil)).Elem()
   143  }
   144  
   145  // A collection of values returned by getSecurityProfile.
   146  type LookupSecurityProfileResultOutput struct{ *pulumi.OutputState }
   147  
   148  func (LookupSecurityProfileResultOutput) ElementType() reflect.Type {
   149  	return reflect.TypeOf((*LookupSecurityProfileResult)(nil)).Elem()
   150  }
   151  
   152  func (o LookupSecurityProfileResultOutput) ToLookupSecurityProfileResultOutput() LookupSecurityProfileResultOutput {
   153  	return o
   154  }
   155  
   156  func (o LookupSecurityProfileResultOutput) ToLookupSecurityProfileResultOutputWithContext(ctx context.Context) LookupSecurityProfileResultOutput {
   157  	return o
   158  }
   159  
   160  // ARN of the Security Profile.
   161  func (o LookupSecurityProfileResultOutput) Arn() pulumi.StringOutput {
   162  	return o.ApplyT(func(v LookupSecurityProfileResult) string { return v.Arn }).(pulumi.StringOutput)
   163  }
   164  
   165  // Description of the Security Profile.
   166  func (o LookupSecurityProfileResultOutput) Description() pulumi.StringOutput {
   167  	return o.ApplyT(func(v LookupSecurityProfileResult) string { return v.Description }).(pulumi.StringOutput)
   168  }
   169  
   170  // The provider-assigned unique ID for this managed resource.
   171  func (o LookupSecurityProfileResultOutput) Id() pulumi.StringOutput {
   172  	return o.ApplyT(func(v LookupSecurityProfileResult) string { return v.Id }).(pulumi.StringOutput)
   173  }
   174  
   175  func (o LookupSecurityProfileResultOutput) InstanceId() pulumi.StringOutput {
   176  	return o.ApplyT(func(v LookupSecurityProfileResult) string { return v.InstanceId }).(pulumi.StringOutput)
   177  }
   178  
   179  func (o LookupSecurityProfileResultOutput) Name() pulumi.StringOutput {
   180  	return o.ApplyT(func(v LookupSecurityProfileResult) string { return v.Name }).(pulumi.StringOutput)
   181  }
   182  
   183  // The organization resource identifier for the security profile.
   184  func (o LookupSecurityProfileResultOutput) OrganizationResourceId() pulumi.StringOutput {
   185  	return o.ApplyT(func(v LookupSecurityProfileResult) string { return v.OrganizationResourceId }).(pulumi.StringOutput)
   186  }
   187  
   188  // List of permissions assigned to the security profile.
   189  func (o LookupSecurityProfileResultOutput) Permissions() pulumi.StringArrayOutput {
   190  	return o.ApplyT(func(v LookupSecurityProfileResult) []string { return v.Permissions }).(pulumi.StringArrayOutput)
   191  }
   192  
   193  func (o LookupSecurityProfileResultOutput) SecurityProfileId() pulumi.StringOutput {
   194  	return o.ApplyT(func(v LookupSecurityProfileResult) string { return v.SecurityProfileId }).(pulumi.StringOutput)
   195  }
   196  
   197  // Map of tags to assign to the Security Profile.
   198  func (o LookupSecurityProfileResultOutput) Tags() pulumi.StringMapOutput {
   199  	return o.ApplyT(func(v LookupSecurityProfileResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
   200  }
   201  
   202  func init() {
   203  	pulumi.RegisterOutputType(LookupSecurityProfileResultOutput{})
   204  }