AwsServiceAccess class
Manages trusted access between an AWS service and AWS Organizations.
> Note: AWS recommends enabling and disabling trusted access for a service through the service's own console or its AWS CLI commands or API operation equivalents, rather than using this resource directly. Using the service-specific tooling ensures that the service can perform the required steps when enabling trusted access (e.g. creating any required resources) and any required clean up operations when disabling trusted access. See the AWS Organizations User Guide for more details. The complete list of AWS services that support trusted access with AWS Organizations is available in the Services that work with Organizations page.
> Note: This resource requires the Organizations management account.
> NOTE: Terraform provides both this standalone AWS service access resource and exclusive service access defined in-line in the aws.organizations.Organization resource via the awsServiceAccessPrincipals argument. At this time, you cannot use the service access in conjunction with this resource otherwise it will cause a perpetual difference in plan output. You can optionally use the generic Terraform resource lifecycle configuration block with ignoreChanges in the aws.organizations.Organization resource to manage additional service access via this resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.organizations.AwsServiceAccess("example", {servicePrincipal: "tagpolicies.tag.amazonaws.com"});
import pulumi
import pulumi_aws as aws
example = aws.organizations.AwsServiceAccess("example", service_principal="tagpolicies.tag.amazonaws.com")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Organizations.AwsServiceAccess("example", new()
{
ServicePrincipal = "tagpolicies.tag.amazonaws.com",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/organizations"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := organizations.NewAwsServiceAccess(ctx, "example", &organizations.AwsServiceAccessArgs{
ServicePrincipal: pulumi.String("tagpolicies.tag.amazonaws.com"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_organizations_awsserviceaccess" "example" {
service_principal = "tagpolicies.tag.amazonaws.com"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.organizations.AwsServiceAccess;
import com.pulumi.aws.organizations.AwsServiceAccessArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 AwsServiceAccess("example", AwsServiceAccessArgs.builder()
.servicePrincipal("tagpolicies.tag.amazonaws.com")
.build());
}
}
resources:
example:
type: aws:organizations:AwsServiceAccess
properties:
servicePrincipal: tagpolicies.tag.amazonaws.com
Import
Identity Schema
Required
servicePrincipal(String) Service principal name of the AWS service for which you want to enable integration.
Optional
accountId(String) AWS Account where this resource is managed.
Using pulumi import, import trusted access using the servicePrincipal. For example:
$ pulumi import aws:organizations/awsServiceAccess:AwsServiceAccess example tagpolicies.tag.amazonaws.com
Constructors
- AwsServiceAccess(String name, {AwsServiceAccessArgs? args, CustomResourceOptions? options})
-
Creates a new AwsServiceAccess.
nameThe Pulumi resource name.argsArguments used to configure this AwsServiceAccess. The set of arguments for AwsServiceAccess.optionsResource options controlling this resource's behavior. - AwsServiceAccess.reference(String urn)
- Creates a typed reference to an existing AwsServiceAccess resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
dateEnabled
↔ Output<
String> -
Date and time that the service was enabled, in RFC 3339 format.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
servicePrincipal
↔ Output<
String> -
Service principal of the AWS service to enable. For example,
tagpolicies.tag.amazonaws.com. Changing this value will force a new resource.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {AwsServiceAccessState? state, CustomResourceOptions? options}) → AwsServiceAccess -
Gets an existing AwsServiceAccess resource's state with the given
nameandid.