Documentation
¶
Index ¶
- type Analyzer
- type AnalyzerArgs
- type AnalyzerArray
- type AnalyzerArrayInput
- type AnalyzerArrayOutput
- type AnalyzerInput
- type AnalyzerMap
- type AnalyzerMapInput
- type AnalyzerMapOutput
- type AnalyzerOutput
- func (o AnalyzerOutput) AnalyzerName() pulumi.StringOutput
- func (o AnalyzerOutput) Arn() pulumi.StringOutput
- func (AnalyzerOutput) ElementType() reflect.Type
- func (o AnalyzerOutput) Tags() pulumi.StringMapOutput
- func (o AnalyzerOutput) TagsAll() pulumi.StringMapOutput
- func (o AnalyzerOutput) ToAnalyzerOutput() AnalyzerOutput
- func (o AnalyzerOutput) ToAnalyzerOutputWithContext(ctx context.Context) AnalyzerOutput
- func (o AnalyzerOutput) Type() pulumi.StringPtrOutput
- type AnalyzerState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Analyzer ¶
type Analyzer struct {
pulumi.CustomResourceState
// Name of the Analyzer.
AnalyzerName pulumi.StringOutput `pulumi:"analyzerName"`
// The Amazon Resource Name (ARN) of the Analyzer.
Arn pulumi.StringOutput `pulumi:"arn"`
// Key-value map of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Tags pulumi.StringMapOutput `pulumi:"tags"`
// A map of tags assigned to the resource, including those inherited from the provider .
TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
// Type of Analyzer. Valid values are `ACCOUNT` or `ORGANIZATION`. Defaults to `ACCOUNT`.
Type pulumi.StringPtrOutput `pulumi:"type"`
}
Manages an Access Analyzer Analyzer. More information can be found in the [Access Analyzer User Guide](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html).
## Example Usage ### Account Analyzer
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/accessanalyzer" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := accessanalyzer.NewAnalyzer(ctx, "example", &accessanalyzer.AnalyzerArgs{
AnalyzerName: pulumi.String("example"),
})
if err != nil {
return err
}
return nil
})
}
``` ### Organization Analyzer
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/accessanalyzer" "github.com/pulumi/pulumi-aws/sdk/v5/go/aws/organizations" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleOrganization, err := organizations.NewOrganization(ctx, "exampleOrganization", &organizations.OrganizationArgs{
AwsServiceAccessPrincipals: pulumi.StringArray{
pulumi.String("access-analyzer.amazonaws.com"),
},
})
if err != nil {
return err
}
_, err = accessanalyzer.NewAnalyzer(ctx, "exampleAnalyzer", &accessanalyzer.AnalyzerArgs{
AnalyzerName: pulumi.String("example"),
Type: pulumi.String("ORGANIZATION"),
}, pulumi.DependsOn([]pulumi.Resource{
exampleOrganization,
}))
if err != nil {
return err
}
return nil
})
}
```
## Import
Access Analyzer Analyzers can be imported using the `analyzer_name`, e.g.,
```sh
$ pulumi import aws:accessanalyzer/analyzer:Analyzer example example
```
func GetAnalyzer ¶
func GetAnalyzer(ctx *pulumi.Context, name string, id pulumi.IDInput, state *AnalyzerState, opts ...pulumi.ResourceOption) (*Analyzer, error)
GetAnalyzer gets an existing Analyzer resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewAnalyzer ¶
func NewAnalyzer(ctx *pulumi.Context, name string, args *AnalyzerArgs, opts ...pulumi.ResourceOption) (*Analyzer, error)
NewAnalyzer registers a new resource with the given unique name, arguments, and options.
func (*Analyzer) ElementType ¶
func (*Analyzer) ToAnalyzerOutput ¶
func (i *Analyzer) ToAnalyzerOutput() AnalyzerOutput
func (*Analyzer) ToAnalyzerOutputWithContext ¶
func (i *Analyzer) ToAnalyzerOutputWithContext(ctx context.Context) AnalyzerOutput
type AnalyzerArgs ¶
type AnalyzerArgs struct {
// Name of the Analyzer.
AnalyzerName pulumi.StringInput
// Key-value map of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Tags pulumi.StringMapInput
// Type of Analyzer. Valid values are `ACCOUNT` or `ORGANIZATION`. Defaults to `ACCOUNT`.
Type pulumi.StringPtrInput
}
The set of arguments for constructing a Analyzer resource.
func (AnalyzerArgs) ElementType ¶
func (AnalyzerArgs) ElementType() reflect.Type
type AnalyzerArray ¶
type AnalyzerArray []AnalyzerInput
func (AnalyzerArray) ElementType ¶
func (AnalyzerArray) ElementType() reflect.Type
func (AnalyzerArray) ToAnalyzerArrayOutput ¶
func (i AnalyzerArray) ToAnalyzerArrayOutput() AnalyzerArrayOutput
func (AnalyzerArray) ToAnalyzerArrayOutputWithContext ¶
func (i AnalyzerArray) ToAnalyzerArrayOutputWithContext(ctx context.Context) AnalyzerArrayOutput
type AnalyzerArrayInput ¶
type AnalyzerArrayInput interface {
pulumi.Input
ToAnalyzerArrayOutput() AnalyzerArrayOutput
ToAnalyzerArrayOutputWithContext(context.Context) AnalyzerArrayOutput
}
AnalyzerArrayInput is an input type that accepts AnalyzerArray and AnalyzerArrayOutput values. You can construct a concrete instance of `AnalyzerArrayInput` via:
AnalyzerArray{ AnalyzerArgs{...} }
type AnalyzerArrayOutput ¶
type AnalyzerArrayOutput struct{ *pulumi.OutputState }
func (AnalyzerArrayOutput) ElementType ¶
func (AnalyzerArrayOutput) ElementType() reflect.Type
func (AnalyzerArrayOutput) Index ¶
func (o AnalyzerArrayOutput) Index(i pulumi.IntInput) AnalyzerOutput
func (AnalyzerArrayOutput) ToAnalyzerArrayOutput ¶
func (o AnalyzerArrayOutput) ToAnalyzerArrayOutput() AnalyzerArrayOutput
func (AnalyzerArrayOutput) ToAnalyzerArrayOutputWithContext ¶
func (o AnalyzerArrayOutput) ToAnalyzerArrayOutputWithContext(ctx context.Context) AnalyzerArrayOutput
type AnalyzerInput ¶
type AnalyzerInput interface {
pulumi.Input
ToAnalyzerOutput() AnalyzerOutput
ToAnalyzerOutputWithContext(ctx context.Context) AnalyzerOutput
}
type AnalyzerMap ¶
type AnalyzerMap map[string]AnalyzerInput
func (AnalyzerMap) ElementType ¶
func (AnalyzerMap) ElementType() reflect.Type
func (AnalyzerMap) ToAnalyzerMapOutput ¶
func (i AnalyzerMap) ToAnalyzerMapOutput() AnalyzerMapOutput
func (AnalyzerMap) ToAnalyzerMapOutputWithContext ¶
func (i AnalyzerMap) ToAnalyzerMapOutputWithContext(ctx context.Context) AnalyzerMapOutput
type AnalyzerMapInput ¶
type AnalyzerMapInput interface {
pulumi.Input
ToAnalyzerMapOutput() AnalyzerMapOutput
ToAnalyzerMapOutputWithContext(context.Context) AnalyzerMapOutput
}
AnalyzerMapInput is an input type that accepts AnalyzerMap and AnalyzerMapOutput values. You can construct a concrete instance of `AnalyzerMapInput` via:
AnalyzerMap{ "key": AnalyzerArgs{...} }
type AnalyzerMapOutput ¶
type AnalyzerMapOutput struct{ *pulumi.OutputState }
func (AnalyzerMapOutput) ElementType ¶
func (AnalyzerMapOutput) ElementType() reflect.Type
func (AnalyzerMapOutput) MapIndex ¶
func (o AnalyzerMapOutput) MapIndex(k pulumi.StringInput) AnalyzerOutput
func (AnalyzerMapOutput) ToAnalyzerMapOutput ¶
func (o AnalyzerMapOutput) ToAnalyzerMapOutput() AnalyzerMapOutput
func (AnalyzerMapOutput) ToAnalyzerMapOutputWithContext ¶
func (o AnalyzerMapOutput) ToAnalyzerMapOutputWithContext(ctx context.Context) AnalyzerMapOutput
type AnalyzerOutput ¶
type AnalyzerOutput struct{ *pulumi.OutputState }
func (AnalyzerOutput) AnalyzerName ¶ added in v5.4.0
func (o AnalyzerOutput) AnalyzerName() pulumi.StringOutput
Name of the Analyzer.
func (AnalyzerOutput) Arn ¶ added in v5.4.0
func (o AnalyzerOutput) Arn() pulumi.StringOutput
The Amazon Resource Name (ARN) of the Analyzer.
func (AnalyzerOutput) ElementType ¶
func (AnalyzerOutput) ElementType() reflect.Type
func (AnalyzerOutput) Tags ¶ added in v5.4.0
func (o AnalyzerOutput) Tags() pulumi.StringMapOutput
Key-value map of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
func (AnalyzerOutput) TagsAll ¶ added in v5.4.0
func (o AnalyzerOutput) TagsAll() pulumi.StringMapOutput
A map of tags assigned to the resource, including those inherited from the provider .
func (AnalyzerOutput) ToAnalyzerOutput ¶
func (o AnalyzerOutput) ToAnalyzerOutput() AnalyzerOutput
func (AnalyzerOutput) ToAnalyzerOutputWithContext ¶
func (o AnalyzerOutput) ToAnalyzerOutputWithContext(ctx context.Context) AnalyzerOutput
func (AnalyzerOutput) Type ¶ added in v5.4.0
func (o AnalyzerOutput) Type() pulumi.StringPtrOutput
Type of Analyzer. Valid values are `ACCOUNT` or `ORGANIZATION`. Defaults to `ACCOUNT`.
type AnalyzerState ¶
type AnalyzerState struct {
// Name of the Analyzer.
AnalyzerName pulumi.StringPtrInput
// The Amazon Resource Name (ARN) of the Analyzer.
Arn pulumi.StringPtrInput
// Key-value map of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Tags pulumi.StringMapInput
// A map of tags assigned to the resource, including those inherited from the provider .
TagsAll pulumi.StringMapInput
// Type of Analyzer. Valid values are `ACCOUNT` or `ORGANIZATION`. Defaults to `ACCOUNT`.
Type pulumi.StringPtrInput
}
func (AnalyzerState) ElementType ¶
func (AnalyzerState) ElementType() reflect.Type