organization

package
v2.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 11, 2023 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type LookupOrganizationResult added in v2.3.1 

type LookupOrganizationResult struct {
	// list of IP addresses in CIDR format that are allowed to access the Buildkite API.
	AllowedApiIpAddresses []string `pulumi:"allowedApiIpAddresses"`
	Id                    string   `pulumi:"id"`
	Uuid                  string   `pulumi:"uuid"`
}

A collection of values returned by getOrganization.

func LookupOrganization added in v2.3.1 

func LookupOrganization(ctx *pulumi.Context, opts ...pulumi.InvokeOption) (*LookupOrganizationResult, error)

## # Data Source: organization

Use this data source to look up the organization settings. It currently supports allowed_api_ip_addresses.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-buildkite/sdk/v2/go/buildkite/Organization"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Organization.GetOrganization(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = ec2.NewSecurityGroup(ctx, "fromBuildkite", &ec2.SecurityGroupArgs{
			Ingress: ec2.SecurityGroupIngressArray{
				&ec2.SecurityGroupIngressArgs{
					FromPort:   pulumi.Int("*"),
					ToPort:     pulumi.Int(443),
					Protocol:   pulumi.String("tcp"),
					CidrBlocks: pulumi.Any(data.Buildkite_organization.Allowed_api_ip_addresses),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

type Organization added in v2.3.1 

type Organization struct {
	pulumi.CustomResourceState

	// A list of IP addresses in CIDR format that are allowed to access the Buildkite API. If not set, all IP addresses are allowed (the same as setting 0.0.0.0/0).
	AllowedApiIpAddresses pulumi.StringArrayOutput `pulumi:"allowedApiIpAddresses"`
	Uuid                  pulumi.StringOutput      `pulumi:"uuid"`
}

## # Resource: organization

This resource allows you to manage the settings for an organization.

You must be an organization administrator to manage organization settings.

Note: The "Allowed API IP Addresses" feature must be enabled on your organization in order to manage the `allowedApiIpAddresses` attribute.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-buildkite/sdk/v2/go/buildkite/Organization"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Organization.NewOrganization(ctx, "testSettings", &Organization.OrganizationArgs{
			AllowedApiIpAddresses: pulumi.StringArray{
				pulumi.String("1.1.1.1/32"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Organization settings can be imported by passing the organization slug to the import command, along with the identifier of the resource.

```sh 

$ pulumi import buildkite:Organization/organization:Organization test_settings test_org

``` 

Your organization's slug can be found in your organisation's [settings](https://buildkite.com/organizations/~/settings) page.

func GetOrganization 

func GetOrganization(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *OrganizationState, opts ...pulumi.ResourceOption) (*Organization, error)

GetOrganization gets an existing Organization 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 NewOrganization added in v2.3.1 

func NewOrganization(ctx *pulumi.Context,
	name string, args *OrganizationArgs, opts ...pulumi.ResourceOption) (*Organization, error)

NewOrganization registers a new resource with the given unique name, arguments, and options.

func (*Organization) ElementType added in v2.3.1 

func (*Organization) ElementType() reflect.Type

func (*Organization) ToOrganizationOutput added in v2.3.1 

func (i *Organization) ToOrganizationOutput() OrganizationOutput

func (*Organization) ToOrganizationOutputWithContext added in v2.3.1 

func (i *Organization) ToOrganizationOutputWithContext(ctx context.Context) OrganizationOutput

type OrganizationArgs added in v2.3.1 

type OrganizationArgs struct {
	// A list of IP addresses in CIDR format that are allowed to access the Buildkite API. If not set, all IP addresses are allowed (the same as setting 0.0.0.0/0).
	AllowedApiIpAddresses pulumi.StringArrayInput
}

The set of arguments for constructing a Organization resource.

func (OrganizationArgs) ElementType added in v2.3.1 

func (OrganizationArgs) ElementType() reflect.Type

type OrganizationArray added in v2.3.1 

type OrganizationArray []OrganizationInput

func (OrganizationArray) ElementType added in v2.3.1 

func (OrganizationArray) ElementType() reflect.Type

func (OrganizationArray) ToOrganizationArrayOutput added in v2.3.1 

func (i OrganizationArray) ToOrganizationArrayOutput() OrganizationArrayOutput

func (OrganizationArray) ToOrganizationArrayOutputWithContext added in v2.3.1 

func (i OrganizationArray) ToOrganizationArrayOutputWithContext(ctx context.Context) OrganizationArrayOutput

type OrganizationArrayInput added in v2.3.1 

type OrganizationArrayInput interface {
	pulumi.Input

	ToOrganizationArrayOutput() OrganizationArrayOutput
	ToOrganizationArrayOutputWithContext(context.Context) OrganizationArrayOutput
}

OrganizationArrayInput is an input type that accepts OrganizationArray and OrganizationArrayOutput values. You can construct a concrete instance of `OrganizationArrayInput` via: 

OrganizationArray{ OrganizationArgs{...} }

type OrganizationArrayOutput added in v2.3.1 

type OrganizationArrayOutput struct{ *pulumi.OutputState }

func (OrganizationArrayOutput) ElementType added in v2.3.1 

func (OrganizationArrayOutput) ElementType() reflect.Type

func (OrganizationArrayOutput) Index added in v2.3.1 

func (o OrganizationArrayOutput) Index(i pulumi.IntInput) OrganizationOutput

func (OrganizationArrayOutput) ToOrganizationArrayOutput added in v2.3.1 

func (o OrganizationArrayOutput) ToOrganizationArrayOutput() OrganizationArrayOutput

func (OrganizationArrayOutput) ToOrganizationArrayOutputWithContext added in v2.3.1 

func (o OrganizationArrayOutput) ToOrganizationArrayOutputWithContext(ctx context.Context) OrganizationArrayOutput

type OrganizationInput added in v2.3.1 

type OrganizationInput interface {
	pulumi.Input

	ToOrganizationOutput() OrganizationOutput
	ToOrganizationOutputWithContext(ctx context.Context) OrganizationOutput
}

type OrganizationMap added in v2.3.1 

type OrganizationMap map[string]OrganizationInput

func (OrganizationMap) ElementType added in v2.3.1 

func (OrganizationMap) ElementType() reflect.Type

func (OrganizationMap) ToOrganizationMapOutput added in v2.3.1 

func (i OrganizationMap) ToOrganizationMapOutput() OrganizationMapOutput

func (OrganizationMap) ToOrganizationMapOutputWithContext added in v2.3.1 

func (i OrganizationMap) ToOrganizationMapOutputWithContext(ctx context.Context) OrganizationMapOutput

type OrganizationMapInput added in v2.3.1 

type OrganizationMapInput interface {
	pulumi.Input

	ToOrganizationMapOutput() OrganizationMapOutput
	ToOrganizationMapOutputWithContext(context.Context) OrganizationMapOutput
}

OrganizationMapInput is an input type that accepts OrganizationMap and OrganizationMapOutput values. You can construct a concrete instance of `OrganizationMapInput` via: 

OrganizationMap{ "key": OrganizationArgs{...} }

type OrganizationMapOutput added in v2.3.1 

type OrganizationMapOutput struct{ *pulumi.OutputState }

func (OrganizationMapOutput) ElementType added in v2.3.1 

func (OrganizationMapOutput) ElementType() reflect.Type

func (OrganizationMapOutput) MapIndex added in v2.3.1 

func (o OrganizationMapOutput) MapIndex(k pulumi.StringInput) OrganizationOutput

func (OrganizationMapOutput) ToOrganizationMapOutput added in v2.3.1 

func (o OrganizationMapOutput) ToOrganizationMapOutput() OrganizationMapOutput

func (OrganizationMapOutput) ToOrganizationMapOutputWithContext added in v2.3.1 

func (o OrganizationMapOutput) ToOrganizationMapOutputWithContext(ctx context.Context) OrganizationMapOutput

type OrganizationOutput added in v2.3.1 

type OrganizationOutput struct{ *pulumi.OutputState }

func (OrganizationOutput) AllowedApiIpAddresses added in v2.3.1 

func (o OrganizationOutput) AllowedApiIpAddresses() pulumi.StringArrayOutput

A list of IP addresses in CIDR format that are allowed to access the Buildkite API. If not set, all IP addresses are allowed (the same as setting 0.0.0.0/0).

func (OrganizationOutput) ElementType added in v2.3.1 

func (OrganizationOutput) ElementType() reflect.Type

func (OrganizationOutput) ToOrganizationOutput added in v2.3.1 

func (o OrganizationOutput) ToOrganizationOutput() OrganizationOutput

func (OrganizationOutput) ToOrganizationOutputWithContext added in v2.3.1 

func (o OrganizationOutput) ToOrganizationOutputWithContext(ctx context.Context) OrganizationOutput

func (OrganizationOutput) Uuid added in v2.3.1 

func (o OrganizationOutput) Uuid() pulumi.StringOutput

type OrganizationState added in v2.3.1 

type OrganizationState struct {
	// A list of IP addresses in CIDR format that are allowed to access the Buildkite API. If not set, all IP addresses are allowed (the same as setting 0.0.0.0/0).
	AllowedApiIpAddresses pulumi.StringArrayInput
	Uuid                  pulumi.StringPtrInput
}

func (OrganizationState) ElementType added in v2.3.1 

func (OrganizationState) ElementType() reflect.Type

type Settings 

type Settings struct {
	pulumi.CustomResourceState

	// A list of IP addresses in CIDR format that are allowed to access the Buildkite API. If not set, all IP addresses are allowed (the same as setting 0.0.0.0/0).
	AllowedApiIpAddresses pulumi.StringArrayOutput `pulumi:"allowedApiIpAddresses"`
	Uuid                  pulumi.StringOutput      `pulumi:"uuid"`
}

## # Resource: organizationSettings

**Note**: This resource has been deprecated. In a future minor release, we will remove this resource in favour of the newer `Organization.Organization` resource that aligns with the datasource of the same name.

This resource allows you to manage the settings for an organization.

You must be an organization administrator to manage organization settings.

Note: The "Allowed API IP Addresses" feature must be enabled on your organization in order to manage the `allowedApiIpAddresses` attribute.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-buildkite/sdk/v2/go/buildkite/Organization"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Organization.NewSettings(ctx, "testSettings", &Organization.SettingsArgs{
			AllowedApiIpAddresses: pulumi.StringArray{
				pulumi.String("1.1.1.1/32"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Organization settings can be imported by passing the organization slug to the import command, along with the identifier of the resource.

```sh 

$ pulumi import buildkite:Organization/settings:Settings test_settings test_org

``` 

Your organization's slug can be found in your organisation's [settings](https://buildkite.com/organizations/~/settings) page.

func GetSettings 

func GetSettings(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *SettingsState, opts ...pulumi.ResourceOption) (*Settings, error)

GetSettings gets an existing Settings 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 NewSettings 

func NewSettings(ctx *pulumi.Context,
	name string, args *SettingsArgs, opts ...pulumi.ResourceOption) (*Settings, error)

NewSettings registers a new resource with the given unique name, arguments, and options.

func (*Settings) ElementType 

func (*Settings) ElementType() reflect.Type

func (*Settings) ToSettingsOutput 

func (i *Settings) ToSettingsOutput() SettingsOutput

func (*Settings) ToSettingsOutputWithContext 

func (i *Settings) ToSettingsOutputWithContext(ctx context.Context) SettingsOutput

type SettingsArgs 

type SettingsArgs struct {
	// A list of IP addresses in CIDR format that are allowed to access the Buildkite API. If not set, all IP addresses are allowed (the same as setting 0.0.0.0/0).
	AllowedApiIpAddresses pulumi.StringArrayInput
}

The set of arguments for constructing a Settings resource.

func (SettingsArgs) ElementType 

func (SettingsArgs) ElementType() reflect.Type

type SettingsArray 

type SettingsArray []SettingsInput

func (SettingsArray) ElementType 

func (SettingsArray) ElementType() reflect.Type

func (SettingsArray) ToSettingsArrayOutput 

func (i SettingsArray) ToSettingsArrayOutput() SettingsArrayOutput

func (SettingsArray) ToSettingsArrayOutputWithContext 

func (i SettingsArray) ToSettingsArrayOutputWithContext(ctx context.Context) SettingsArrayOutput

type SettingsArrayInput 

type SettingsArrayInput interface {
	pulumi.Input

	ToSettingsArrayOutput() SettingsArrayOutput
	ToSettingsArrayOutputWithContext(context.Context) SettingsArrayOutput
}

SettingsArrayInput is an input type that accepts SettingsArray and SettingsArrayOutput values. You can construct a concrete instance of `SettingsArrayInput` via: 

SettingsArray{ SettingsArgs{...} }

type SettingsArrayOutput 

type SettingsArrayOutput struct{ *pulumi.OutputState }

func (SettingsArrayOutput) ElementType 

func (SettingsArrayOutput) ElementType() reflect.Type

func (SettingsArrayOutput) Index 

func (o SettingsArrayOutput) Index(i pulumi.IntInput) SettingsOutput

func (SettingsArrayOutput) ToSettingsArrayOutput 

func (o SettingsArrayOutput) ToSettingsArrayOutput() SettingsArrayOutput

func (SettingsArrayOutput) ToSettingsArrayOutputWithContext 

func (o SettingsArrayOutput) ToSettingsArrayOutputWithContext(ctx context.Context) SettingsArrayOutput

type SettingsInput 

type SettingsInput interface {
	pulumi.Input

	ToSettingsOutput() SettingsOutput
	ToSettingsOutputWithContext(ctx context.Context) SettingsOutput
}

type SettingsMap 

type SettingsMap map[string]SettingsInput

func (SettingsMap) ElementType 

func (SettingsMap) ElementType() reflect.Type

func (SettingsMap) ToSettingsMapOutput 

func (i SettingsMap) ToSettingsMapOutput() SettingsMapOutput

func (SettingsMap) ToSettingsMapOutputWithContext 

func (i SettingsMap) ToSettingsMapOutputWithContext(ctx context.Context) SettingsMapOutput

type SettingsMapInput 

type SettingsMapInput interface {
	pulumi.Input

	ToSettingsMapOutput() SettingsMapOutput
	ToSettingsMapOutputWithContext(context.Context) SettingsMapOutput
}

SettingsMapInput is an input type that accepts SettingsMap and SettingsMapOutput values. You can construct a concrete instance of `SettingsMapInput` via: 

SettingsMap{ "key": SettingsArgs{...} }

type SettingsMapOutput 

type SettingsMapOutput struct{ *pulumi.OutputState }

func (SettingsMapOutput) ElementType 

func (SettingsMapOutput) ElementType() reflect.Type

func (SettingsMapOutput) MapIndex 

func (o SettingsMapOutput) MapIndex(k pulumi.StringInput) SettingsOutput

func (SettingsMapOutput) ToSettingsMapOutput 

func (o SettingsMapOutput) ToSettingsMapOutput() SettingsMapOutput

func (SettingsMapOutput) ToSettingsMapOutputWithContext 

func (o SettingsMapOutput) ToSettingsMapOutputWithContext(ctx context.Context) SettingsMapOutput

type SettingsOutput 

type SettingsOutput struct{ *pulumi.OutputState }

func (SettingsOutput) AllowedApiIpAddresses 

func (o SettingsOutput) AllowedApiIpAddresses() pulumi.StringArrayOutput

A list of IP addresses in CIDR format that are allowed to access the Buildkite API. If not set, all IP addresses are allowed (the same as setting 0.0.0.0/0).

func (SettingsOutput) ElementType 

func (SettingsOutput) ElementType() reflect.Type

func (SettingsOutput) ToSettingsOutput 

func (o SettingsOutput) ToSettingsOutput() SettingsOutput

func (SettingsOutput) ToSettingsOutputWithContext 

func (o SettingsOutput) ToSettingsOutputWithContext(ctx context.Context) SettingsOutput

func (SettingsOutput) Uuid 

func (o SettingsOutput) Uuid() pulumi.StringOutput

type SettingsState 

type SettingsState struct {
	// A list of IP addresses in CIDR format that are allowed to access the Buildkite API. If not set, all IP addresses are allowed (the same as setting 0.0.0.0/0).
	AllowedApiIpAddresses pulumi.StringArrayInput
	Uuid                  pulumi.StringPtrInput
}

func (SettingsState) ElementType 

func (SettingsState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.